commerce

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

Preview an order's refund eligibility.

Lahat ng commerce endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na billing.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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

Mga Parameter

PangalanUriKailanganAno ito
orderId (path)UuidOoThe order's id.

Tugon

PangalanUriKailanganAno ito
eligiblebooleanOo
policy_classRefundPolicyClassOoHow the refund policy classified a request (captured at request time).
requires_approvalbooleanOo
auto_approvedbooleanOoEligible and needs no human — the money-back path issues immediately.
amountMoneyAmountOoA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
reasonstringOoA customer-safe explanation of the decision.

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 429