commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
orderId (path) | Uuid | Ano | The order's id. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
eligible | boolean | Ano | — |
policy_class | RefundPolicyClass | Ano | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Ano | — |
auto_approved | boolean | Ano | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Ano | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Ano | A customer-safe explanation of the decision. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 429