commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
orderId (path) | Uuid | Ja | The order's id. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
eligible | boolean | Ja | — |
policy_class | RefundPolicyClass | Ja | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Ja | — |
auto_approved | boolean | Ja | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Ja | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Ja | A customer-safe explanation of the decision. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 429