commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
The refund policy's decision for this order without opening a request — whether it is eligible, the amount that would be refunded, and whether it needs staff approval (docs/05 §4.13). Requires `billing.view`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
orderId (path) | Uuid | Oui | The order's id. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
eligible | boolean | Oui | — |
policy_class | RefundPolicyClass | Oui | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Oui | — |
auto_approved | boolean | Oui | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Oui | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Oui | A customer-safe explanation of the decision. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429