commerce

POST /v1/carts/{cartId}/lines

Add a line to a cart.

Всички крайни точки в commerce

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

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

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

Adds a priced line. A `hosting_plan` line needs a `plan_version_id`; a `domain_register`/`domain_transfer`/`domain_renew` line needs a `domain_name`, `tld` and `period_years`. The line shape and price are validated + stamped by the server; a bad shape (or a plan version with no price) is a `422`.

Параметри

ИмеТипЗадължителноКакво представлява
cartId (path)UuidДаThe cart's id.

Тяло на заявката

ИмеТипЗадължителноКакво представлява
kindSellableLineKindДаThe line kinds a cart will accept **today** — the write-side subset of `LineKind`. Narrower than `LineKind` on purpose. `LineKind` is what a line can *be* (a read shape, includi…
domain_namestringНеRequired for a domain line.
tldstringНеRequired for a domain line.
period_yearsintegerНеRequired for a register/transfer/renew line.
privacybooleanНе
auto_renewbooleanНе
availability_tokenstringНеThe signed token from `searchDomains` for this exact name. Optional: an ordinary name prices from the TLD catalogue without one. It is **required to buy a premium name**, becaus…
auth_codestringНеThe EPP/authorization code issued by the registrar the domain is currently held at. **Required for a `domain_transfer` line** — no registry will initiate a transfer without it,…
registrar_routeRegistrationRouteKeyНеWhich registrar buys the name, on a `domain_register` or `domain_transfer` line. Omit it for the organisation's own registrar, which is the behaviour every caller had before thi…
plan_version_idUuid | nullНеRequired for a `hosting_plan` line — the immutable plan version to bill.
listing_package_idUuid | nullНеRequired for a `marketplace_package` line — the package on a **live** listing being bought. The price is the seller's and is re-read on every basket read, so a client-sent amoun…
intervalBillingIntervalНеThe recurrence a price is quoted for.
regionstringНеThe data centre this hosting is bought for — carried onto the resulting subscription and used as the default region for sites created against it (docs/370). Blank or omitted mea…
computeComputeLineConfigНеHow one machine on a `compute_server` cart line is built. The values are **not trusted from here**: the engine re-resolves the whole order against the live vendor before the lin…
databaseDatabaseLineConfigНеThe managed database a `managed_database` cart line buys (`docs/497` §8). The values are **not trusted from here**: the engine re-resolves the whole purchase through the same va…

Отговор

ИмеТипЗадължителноКакво представлява
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<open, checking_out, converted, abandoned, expired>Да
currencyCurrencyCode | nullНеFixed 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_lineobjectНе
linesCartLine[]Да
subtotalMoneyAmountДаA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
discountMoneyAmountДаA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
totalMoneyAmountДаA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
created_atstringДа
updated_atstringНе

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429