commerce

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

Preview an order's refund eligibility.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar billing.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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`.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`orderId (path)`	`Uuid`	Evet	The order's id.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`eligible`	`boolean`	Evet	—
`policy_class`	`RefundPolicyClass`	Evet	How the refund policy classified a request (captured at request time).
`requires_approval`	`boolean`	Evet	—
`auto_approved`	`boolean`	Evet	Eligible and needs no human — the money-back path issues immediately.
`amount`	`MoneyAmount`	Evet	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`reason`	`string`	Evet	A customer-safe explanation of the decision.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 429

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