commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea billing.view; o cheie care nu o are va fi respinsă cu 403, nu 404.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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`.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
orderId (path) | Uuid | Da | The order's id. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
eligible | boolean | Da | — |
policy_class | RefundPolicyClass | Da | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Da | — |
auto_approved | boolean | Da | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Da | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Da | A customer-safe explanation of the decision. |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 429