commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл billing.view; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 429