commerce

GET `/v1/orders/{orderId}/refund-eligibility`

Preview an order's refund eligibility.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya billing.view; ufunguo usio nayo unakataliwa kwa 403, si 404.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
  -H "Authorization: Bearer zdk_live_…"

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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`.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`orderId (path)`	`Uuid`	Ndiyo	The order's id.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`eligible`	`boolean`	Ndiyo	—
`policy_class`	`RefundPolicyClass`	Ndiyo	How the refund policy classified a request (captured at request time).
`requires_approval`	`boolean`	Ndiyo	—
`auto_approved`	`boolean`	Ndiyo	Eligible and needs no human — the money-back path issues immediately.
`amount`	`MoneyAmount`	Ndiyo	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`reason`	`string`	Ndiyo	A customer-safe explanation of the decision.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 429

GET /v1/orders/{orderId}/refund-eligibility