commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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