commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
orderId (path) | Uuid | Tak | The order's id. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
eligible | boolean | Tak | — |
policy_class | RefundPolicyClass | Tak | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Tak | — |
auto_approved | boolean | Tak | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Tak | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Tak | A customer-safe explanation of the decision. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 429