commerce

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

Preview an order's refund eligibility.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس billing.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو 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