API des polices

Utilisez l’API des polices pour interroger les polices de garantie — les contrats de couverture créés lorsqu’un client achète une garantie.

Récupérer les polices d’un client

GET /api/public/policies/fetch

Renvoie toutes les polices de garantie d’un client. Ajoutez ?policy_id={id} pour récupérer une seule police avec les données de sa commande.

En-têtes obligatoires : X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Chaque police comprend : le numéro de police, le statut, les informations client, les informations de commande, les détails du plan de garantie, les détails du produit protégé et les dates de couverture.

Récupérer une police par ID

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

Renvoie une police précise à partir de son ID.

Paramètres de requête :

• shopDomain (obligatoire) — le domaine de votre boutique Shopify
• customerId (facultatif) — s’il est fourni, inclut les données de la commande et vérifie que la police appartient bien au client

Trouver une police à partir d’un article de commande

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

Trouve la police de garantie associée à un article précis d’une commande. Utilisé sur les pages de statut de commande pour afficher la couverture de garantie de chaque produit.

En-tête obligatoire : X-Shopify-Shop-Domain

Paramètres du corps :

• orderId ou orderName (l’un des deux est obligatoire) — identifie la commande
• lineItemId, variantId ou position (au moins un est obligatoire) — identifie l’article
• protectionAttributes (facultatif) — référence de protection issue de la transformation du panier

Valider une police

POST /api/public/policies/validate

Vérifie qu’une police existe en faisant correspondre à la fois l’ID de la police et le nom de la commande. Utilisé comme étape de sécurité dans les formulaires de réclamation intégrés.

Champs obligatoires du corps : orderName, policyId

Renvoie { "valid": true } ou { "valid": false }.

Statuts des polices

Statut	Description
active	Dans la période de couverture, peut recevoir des réclamations
expired	Période de couverture terminée
cancelled	Annulée (remboursement ou action du commerçant)
pending	En cours de traitement (en attente de confirmation de la commande)
voided	Invalidée suite à l’annulation de la commande ou à une rétrofacturation

Voir aussi

• API des réclamations — Déposez des réclamations au titre des polices
• API des garanties — Détails des plans de garantie
• API des produits — Vérifications d’éligibilité des produits