commerce
POST /v1/carts/{cartId}/checkout
Check out a cart — place and charge an order.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.payment.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/carts/{cartId}/checkout \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
cartId (path) | Uuid | Ano | The cart's id. |
Idempotency-Key (header) | string | Ne | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
billing_country | object | Ne | ISO 3166-1 alpha-2 country for the tax jurisdiction. |
availability_tokens | object | Ne | 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 | Ne | 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 | Ne | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
human_ref | string | Ano | Human-friendly order reference. |
status | OrderStatus | Ano | An order's lifecycle state (docs/31 §4.3). |
currency | CurrencyCode | Ano | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Ano | — |
tax_minor | integer | Ano | — |
discount_minor | integer | Ano | — |
total_minor | integer | Ano | — |
billing_country | object | Ne | — |
placed_at | object | Ne | — |
created_at | string | Ano | — |
updated_at | string | Ne | — |
lines | OrderLine[] | Ano | — |
payments | Payment[] | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 409 · 422 · 429