commerce

GET /v1/orders/{orderId}

Get an order.

Tất cả các điểm cuối commerce

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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

Tham số

TênLoạiBắt buộcNội dung này là gì
orderId (path)UuidThe order's id.

Phản hồi

TênLoạiBắt buộcNội dung này là gì
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringHuman-friendly order reference.
statusOrderStatusAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorinteger
tax_minorinteger
discount_minorinteger
total_minorinteger
billing_countryobjectKhông
placed_atobjectKhông
created_atstring
updated_atstringKhông
linesOrderLine[]
paymentsPayment[]

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 429