commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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éterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
orderId (path) | Uuid | Igen | The order's id. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
eligible | boolean | Igen | — |
policy_class | RefundPolicyClass | Igen | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Igen | — |
auto_approved | boolean | Igen | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Igen | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Igen | A customer-safe explanation of the decision. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 429