commerce

GET /v1/orders/{orderId}

Get an order.

همه نقاط پایانی commerce

احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Returns one order with its lines and payment summaries. RBAC + RLS scoped.

پارامترها

نامنوعالزامیچیست
orderId (path)UuidبلهThe order's id.

پاسخ

نامنوعالزامیچیست
idUuidبلهUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidبلهUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringبلهHuman-friendly order reference.
statusOrderStatusبلهAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeبلهISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerبله
tax_minorintegerبله
discount_minorintegerبله
total_minorintegerبله
billing_countryobjectخیر
placed_atobjectخیر
created_atstringبله
updated_atstringخیر
linesOrderLine[]بله
paymentsPayment[]بله

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 429