commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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