Claims API
Garantieansprüche programmgesteuert einreichen und verwalten
Claims API
Mit der Claims API reichen Sie Garantieansprüche ein, laden Nachweisdateien hoch und fragen den Status von Ansprüchen ab.
Anspruch einreichen
POST /api/public/claims/submit
Reicht einen Anspruch gegen eine bestehende Police ein. Der Anspruch wird mit dem Status pending angelegt und löst E-Mail-Benachrichtigungen an Kunde und Händler aus.
Header (empfohlen): X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Pflichtfelder im Body:
policyId— die Police, gegen die der Anspruch eingereicht wirdclaimType— siehe Anspruchsarten untendescription— was passiert istdateOfIncident— ISO-Datum des Vorfalls
Optional: additionalInfo
Anspruchsarten
| Wert | Beschreibung |
|---|---|
manufacturer_defect | Produkt ist aufgrund eines Herstellungsfehlers ausgefallen |
accidental_damage | Versehentlich beschädigt |
wear_and_tear | Durch normale Nutzung abgenutzt |
spill_or_stain | Durch Flüssigkeit oder Flecken beschädigt |
lost_or_stolen | Verloren oder gestohlen |
other | Sonstiger Grund |
Gibt bei Erfolg claimId zurück. Hat die Police ihr Anspruchslimit erreicht, wird ein Fehler CLAIM_LIMIT_REACHED mit Details zurückgegeben.
Manuellen Anspruch einreichen
POST /api/public/claims/submit-manual
Reicht einen Anspruch ohne bestehende Police ein. Wird für vom Händler angelegte Ansprüche verwendet (z. B. aus dem POS).
Pflicht-Header: X-Shopify-Shop-Domain
Pflichtfelder im Body: customerEmail, customerName, productName, claimType, description, dateOfIncident
Optional: customerPhone, orderNumber, additionalInfo
Ansprüche zu einer Police abrufen
GET /api/public/claims/fetch?policy_id={policyId}
Pflicht-Header: X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Gibt alle Ansprüche zur angegebenen Police und zum Kunden zurück, einschließlich Anspruchsnummer, Status, Art, Grund und Datumsangaben.
Nachweise zu einem Anspruch abrufen
GET /api/public/claims/{id}/evidence
Pflicht-Header: X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Gibt die an den Anspruch angehängten Nachweisdateien (Fotos, Videos) zurück.
Nachweisdateien hochladen
POST /api/public/claims/upload-urls
Erzeugt eine vorsignierte URL, über die Nachweise direkt in den Cloud-Speicher hochgeladen werden.
Pflichtfelder im Body: fileName, fileType (MIME-Typ), fileSize (Bytes), claimId, fileCategory (photo oder video)
Dateilimits:
- Fotos (JPEG, PNG, GIF, WebP): max. 10 MB
- Videos (MP4, QuickTime, WebM): max. 100 MB
Ablauf beim Hochladen:
- Rufen Sie
/claims/upload-urlsauf, um eine vorsignierte URL zu erhalten - Senden Sie die Datei per PUT direkt an diese URL, mit dem korrekten Content-Type-Header
Anspruchsstatus
| Status | Beschreibung |
|---|---|
pending | Eingereicht, wartet auf Prüfung durch den Händler |
approved | Vom Händler genehmigt |
denied | Vom Händler abgelehnt |
in_review | Wird aktiv geprüft |
resolved | Vollständig gelöst (Ersatz, Erstattung usw.) |
Verwandte Themen
- Policies API — Policen nachschlagen, bevor Sie Ansprüche einreichen
- Warranty API — Details zu Garantieplänen
- Webhook-Referenz — Benachrichtigungen erhalten, wenn sich der Status eines Anspruchs ändert
