commerce

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

Preview an order's refund eligibility.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს billing.view ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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