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