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