commerce

POST /v1/carts/{cartId}/checkout

Check out a cart — place and charge an order.

Wszystkie punkty końcowe commerce

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.payment.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

NazwaTypWymaganeCo to jest
cartId (path)UuidTakThe cart's id.
Idempotency-Key (header)stringNieClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Treść żądania

NazwaTypWymaganeCo to jest
billing_countryobjectNieISO 3166-1 alpha-2 country for the tax jurisdiction.
availability_tokensobjectNiedomain_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.
gatewayobjectNieThe 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_minorobjectNieThe 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…

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringTakHuman-friendly order reference.
statusOrderStatusTakAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeTakISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerTak
tax_minorintegerTak
discount_minorintegerTak
total_minorintegerTak
billing_countryobjectNie
placed_atobjectNie
created_atstringTak
updated_atstringNie
linesOrderLine[]Tak
paymentsPayment[]Tak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 409 · 422 · 429