commerce

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

Preview an order's refund eligibility.

Барлық commerce соңғы нүктелері

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте billing.view рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Параметрлер

АтыTүріМіндеттіМазмұны
orderId (path)UuidИәThe order's id.

Жауап

АтыTүріМіндеттіМазмұны
eligiblebooleanИә
policy_classRefundPolicyClassИәHow the refund policy classified a request (captured at request time).
requires_approvalbooleanИә
auto_approvedbooleanИәEligible and needs no human — the money-back path issues immediately.
amountMoneyAmountИәA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
reasonstringИәA customer-safe explanation of the decision.

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404 · 429