commerce

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

Preview an order's refund eligibility.

Gbogbo àwọn commerce endpoints

Gbogbo àwọn ìwé àṣẹ olùgbékalẹ̀ àgbékalẹ̀

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda billing.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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.

Àwọn ìpìlẹ̀

OrúkọIruTí a nílòKini o jẹ
orderId (path)UuidBẹẹniThe order's id.

Idahun

OrúkọIruTí a nílòKini o jẹ
eligiblebooleanBẹẹni
policy_classRefundPolicyClassBẹẹniHow the refund policy classified a request (captured at request time).
requires_approvalbooleanBẹẹni
auto_approvedbooleanBẹẹniEligible and needs no human — the money-back path issues immediately.
amountMoneyAmountBẹẹniA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
reasonstringBẹẹniA customer-safe explanation of the decision.

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 429