commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението billing.view; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
orderId (path) | Uuid | Да | The order's id. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
eligible | boolean | Да | — |
policy_class | RefundPolicyClass | Да | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Да | — |
auto_approved | boolean | Да | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Да | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Да | A customer-safe explanation of the decision. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429