commerce

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

Preview an order's refund eligibility.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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