API Garantie

Utilisez l’API Garantie pour récupérer les détails d’un plan de garantie et vérifier l’éligibilité d’un produit à une couverture de garantie.

Obtenir une garantie par ID

GET /api/public/warranty/{warrantyId}

Renvoie les détails du plan de garantie et sa représentation sous forme de produit Shopify (utilisée pour ajouter la garantie au panier).

Paramètre de chemin : warrantyId (obligatoire) — l’ID du plan de garantie.

Renvoie l’objet garantie avec le type de plan, le statut, les conditions (durée et prix), les détails de couverture et le produit Shopify correspondant, avec les ID et les prix de ses variantes.

Vérifier l’éligibilité à la garantie (par produit)

GET / POST /api/public/warranty-eligibility

Vérifie si un produit est éligible à une couverture de garantie et renvoie les plans disponibles. C’est le principal endpoint utilisé par le widget de la boutique.

En-têtes obligatoires :

• X-Shopify-Shop-Domain — le domaine de votre boutique
• X-Shopify-Product-Id — l’ID du produit à vérifier (ou à passer dans le corps ou la requête)

Corps POST ou paramètres de requête GET :

• shopifyShopDomain (obligatoire) — le domaine de votre boutique
• eligibleProductId (obligatoire) — l’ID du produit Shopify
• cached (facultatif) — définissez-le sur false pour contourner le cache

Renvoie l’extension de garantie éligible (avec les données du produit Shopify), la garantie OEM éligible, les limites du forfait, les informations du commerçant, la langue, les traductions et les données de devise.

Vérifier l’éligibilité à la garantie (ligne de commande)

POST /api/public/warranty/eligibility

Vérifie l’éligibilité d’une ligne de commande précise. Utilisé dans les contextes post-achat et de page de statut de commande.

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 la ligne de commande

L’endpoint recherche la ligne de commande d’abord par lineItemId, puis par variantId, puis par position. Le format de réponse est identique à celui de l’endpoint d’éligibilité par produit.

Types de plan

Type de plan	Valeur	Description
Extension de garantie	extended_warranty	Garantie payante achetée lors du paiement
Garantie OEM	oem_warranty	Garantie du fabricant incluse sans frais

Voir aussi

• Authentification — Identifiants API et limites de débit
• Aperçu des endpoints — Liste complète des endpoints
• API Produits — Recherche de produits et éligibilité
• API Polices — Gestion des polices après l’achat