commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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