commerce

POST `/v1/carts/{cartId}/checkout`

Check out a cart — place and charge an order.

所有 commerce 端点

所有开发者文档 →

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

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

免费试用

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

curl -X POST https://api.zinndigital.com/v1/carts/{cartId}/checkout \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

详细信息

Converts the cart to an immutable order: re-prices every line, re-verifies each domain availability token (a stale/taken one is a 409, with no charge), computes tax, places the order and charges it wallet-first. Fulfilment (provisioning/registration) then runs asynchronously as a Temporal workflow — this call never blocks on it (§2.9); poll the order status or the resource it produces. An Idempotency-Key header is required: a retried checkout returns the same order and never charges twice. Requires billing.payment.manage.

参数

名称	类型	必填	内容简介
`cartId (path)`	`Uuid`	是	The cart's id.
`Idempotency-Key (header)`	`string`	否	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

请求正文

名称	类型	必填	内容简介
`billing_country`	`object`	否	ISO 3166-1 alpha-2 country for the tax jurisdiction.
`availability_tokens`	`object`	否	`domain_name` → the availability token issued by the domain search endpoint. Required for every `domain_register` line; each is re-verified at checkout and a stale one is a `409`.
`gateway`	`object`	否	The payment rail the customer chose at checkout — one of the codes `getPaymentOptions` returned for this organization and currency. Omit it and the order is charged wallet-first…
`expected_total_minor`	`object`	否	The order total the checkout page displayed to the customer, in minor units. Send it and checkout refuses with `422` when the basket no longer comes to that figure; omit it…

响应

名称	类型	必填	内容简介
`id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`human_ref`	`string`	是	Human-friendly order reference.
`status`	`OrderStatus`	是	An order's lifecycle state (docs/31 §4.3).
`currency`	`CurrencyCode`	是	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	是	—
`tax_minor`	`integer`	是	—
`discount_minor`	`integer`	是	—
`total_minor`	`integer`	是	—
`billing_country`	`object`	否	—
`placed_at`	`object`	否	—
`created_at`	`string`	是	—
`updated_at`	`string`	否	—
`lines`	`OrderLine[]`	是	—
`payments`	`Payment[]`	是	—

此端点可能返回的错误

401 · 403 · 404 · 409 · 422 · 429

POST /v1/carts/{cartId}/checkout