Policen-API

Mit der Policen-API fragen Sie Garantiepolicen ab — die Deckungsdatensätze, die entstehen, wenn ein Kunde eine Garantie kauft.

Policen nach Kunde abrufen

GET /api/public/policies/fetch

Gibt alle Garantiepolicen eines Kunden zurück. Hängen Sie ?policy_id={id} an, um eine einzelne Police samt Bestelldaten abzurufen.

Pflicht-Header: X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Jede Police enthält: Policennummer, Status, Kundeninformationen, Bestellinformationen, Details zum Garantieplan, Details zum geschützten Produkt und Deckungsdaten.

Police nach ID abrufen

GET /api/public/policies/fetch/{policyId}

Gibt eine bestimmte Police anhand ihrer ID zurück.

Query-Parameter:

• shopDomain (erforderlich) — die Domain Ihres Shopify-Shops
• customerId (optional) — falls angegeben, werden Bestelldaten einbezogen und die Zugehörigkeit zum Kunden geprüft

Police nach Bestellposition finden

POST /api/public/policies/fetch/order-line-item-policy

Findet die Garantiepolice für eine bestimmte Position einer Bestellung. Wird auf Bestellstatusseiten verwendet, um die Garantiedeckung pro Produkt anzuzeigen.

Pflicht-Header: X-Shopify-Shop-Domain

Body-Parameter:

• orderId oder orderName (einer erforderlich) — identifiziert die Bestellung
• lineItemId, variantId oder position (mindestens einer erforderlich) — identifiziert die Position
• protectionAttributes (optional) — Schutzreferenz aus dem Cart Transform

Eine Police validieren

POST /api/public/policies/validate

Prüft, ob eine Police existiert, indem sowohl die Policen-ID als auch der Bestellname abgeglichen werden. Dient als Sicherheitsschritt in eingebetteten Anspruchsformularen.

Pflichtfelder im Body: orderName, policyId

Gibt { "valid": true } oder { "valid": false } zurück.

Policenstatus

Status	Beschreibung
active	Innerhalb des Deckungszeitraums, Ansprüche möglich
expired	Deckungszeitraum beendet
cancelled	Storniert (Erstattung oder Aktion des Händlers)
pending	In Bearbeitung (wartet auf Bestellbestätigung)
voided	Ungültig aufgrund einer Bestellstornierung oder Rückbuchung

Verwandte Themen

• Claims API — Ansprüche zu Policen einreichen
• Garantie-API — Details zu Garantieplänen
• Produkt-API — Prüfung der Produktberechtigung