commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso billing.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
orderId (path) | Uuid | Sí | The order's id. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
eligible | boolean | Sí | — |
policy_class | RefundPolicyClass | Sí | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Sí | — |
auto_approved | boolean | Sí | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Sí | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Sí | A customer-safe explanation of the decision. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429