commerce

GET /v1/orders/{orderId}

Get an order.

所有 commerce 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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

参数

名称类型必填内容简介
orderId (path)UuidThe order's id.

响应

名称类型必填内容简介
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_countryobject
placed_atobject
created_atstring
updated_atstring
linesOrderLine[]
paymentsPayment[]

此端点可能返回的错误

401 · 403 · 404 · 429