commerce

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

Preview an order's refund eligibility.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա billing.view թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության 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

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