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