commerce

POST /v1/carts

Open a shopping cart.

All commerce endpoints

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Creates an empty open cart for the organization. Prices on its lines are server-authoritative and re-computed on every read (the client price is never trusted). Requires `billing.payment.manage`.

Request body

NameTypeRequiredWhat it is
org_idUuid | nullNoDefaults to the caller's org; the caller must hold `billing.payment.manage` there.
product_linestringNo
currencyCurrencyCode | nullNoThe currency to open the basket in — what the customer will be **billed** in. Omit it and the engine uses the `X-Zinn-Currency` header the dashboard already sends, falling back…

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<open, checking_out, converted, abandoned, expired>Yes
currencyCurrencyCode | nullNoFixed when the cart is opened, from `CartCreate.currency` or the `X-Zinn-Currency` header, and then locked — every line must match it. Null only on a legacy cart created before…
product_lineobjectNo
linesCartLine[]Yes
subtotalMoneyAmountYesA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
discountMoneyAmountYesA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
totalMoneyAmountYesA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
created_atstringYes
updated_atstringNo

Errors this endpoint can return

401 · 403 · 422 · 429