API des réclamations
Déposez et gérez des réclamations de garantie par programmation
API des réclamations
Utilisez l’API des réclamations pour soumettre des réclamations de garantie, envoyer des fichiers justificatifs et consulter le statut des réclamations.
Soumettre une réclamation
POST /api/public/claims/submit
Soumet une réclamation au titre d’une police existante. La réclamation est créée avec le statut pending et déclenche l’envoi de notifications par e-mail au client et au commerçant.
En-têtes (recommandés) : X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Champs obligatoires du corps :
policyId— la police concernée par la réclamationclaimType— voir les types de réclamation ci-dessousdescription— ce qui s’est passédateOfIncident— date de l’incident au format ISO
Facultatif : additionalInfo
Types de réclamation
| Valeur | Description |
|---|---|
manufacturer_defect | Le produit est tombé en panne à cause d’un défaut de fabrication |
accidental_damage | Endommagé par accident |
wear_and_tear | Détérioré par une utilisation normale |
spill_or_stain | Endommagé par un liquide ou une tache |
lost_or_stolen | Perdu ou volé |
other | Autre motif |
Renvoie claimId en cas de succès. Si la police a atteint sa limite de réclamations, renvoie une erreur CLAIM_LIMIT_REACHED accompagnée de détails.
Soumettre une réclamation manuelle
POST /api/public/claims/submit-manual
Soumet une réclamation sans police existante. Sert aux réclamations initiées par le commerçant (par exemple depuis un point de vente).
En-tête obligatoire : X-Shopify-Shop-Domain
Champs obligatoires du corps : customerEmail, customerName, productName, claimType, description, dateOfIncident
Facultatif : customerPhone, orderNumber, additionalInfo
Récupérer les réclamations d’une police
GET /api/public/claims/fetch?policy_id={policyId}
En-têtes obligatoires : X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Renvoie toutes les réclamations de la police et du client indiqués, avec le numéro de réclamation, le statut, le type, le motif et les dates.
Obtenir les justificatifs d’une réclamation
GET /api/public/claims/{id}/evidence
En-têtes obligatoires : X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Renvoie les fichiers justificatifs (photos, vidéos) joints à la réclamation.
Envoyer des fichiers justificatifs
POST /api/public/claims/upload-urls
Génère une URL présignée pour envoyer un justificatif directement vers le stockage cloud.
Champs obligatoires du corps : fileName, fileType (type MIME), fileSize (en octets), claimId, fileCategory (photo ou video)
Limites de fichiers :
- Photos (JPEG, PNG, GIF, WebP) : 10 Mo maximum
- Vidéos (MP4, QuickTime, WebM) : 100 Mo maximum
Procédure d’envoi :
- Appelez
/claims/upload-urlspour obtenir une URL présignée - Envoyez le fichier par PUT directement à cette URL, avec le bon en-tête Content-Type
Statuts des réclamations
| Statut | Description |
|---|---|
pending | Soumise, en attente d’examen par le commerçant |
approved | Approuvée par le commerçant |
denied | Refusée par le commerçant |
in_review | En cours d’examen |
resolved | Entièrement résolue (remplacement, remboursement, etc.) |
Voir aussi
- API des polices — Recherchez les polices avant de déposer une réclamation
- API des garanties — Détails des plans de garantie
- Référence des Webhooks — Soyez notifié lorsque le statut d’une réclamation change
