commerce

GET /v1/orders/{orderId}

Get an order.

จุดสิ้นสุด commerce ทั้งหมด

การยืนยันตัวตน

ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา

ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น

ทดลองใช้เลย

แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ

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