commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran billing.view; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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`.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
orderId (path) | Uuid | Ya | The order's id. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
eligible | boolean | Ya | — |
policy_class | RefundPolicyClass | Ya | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Ya | — |
auto_approved | boolean | Ya | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Ya | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Ya | A customer-safe explanation of the decision. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 429