commerce

POST /v1/carts/{cartId}/checkout

Check out a cart — place and charge an order.

Все эндпоинты commerce

Вся документация для разработчиков

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.payment.manage; ключ без него отклоняется с кодом 403, а не 404.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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_countryobjectНетISO 3166-1 alpha-2 country for the tax jurisdiction.
availability_tokensobjectНет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.
gatewayobjectНет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_minorobjectНет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…

Ответ

ИмяТипОбязательноЧто это
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 · 409 · 422 · 429