commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
認証
ベアラー トークンとして API キーを送信します。キーには billing.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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