commerce

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

Preview an order's refund eligibility.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग 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