commerce

POST /v1/carts/{cartId}/lines

Add a line to a cart.

Minden commerce végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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`.

Paraméterek

NévTípusKötelezőMi ez
cartId (path)UuidIgenThe cart's id.

Kérés törzse

NévTípusKötelezőMi ez
kindSellableLineKindIgenThe 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_namestringNemRequired for a domain line.
tldstringNemRequired for a domain line.
period_yearsintegerNemRequired for a register/transfer/renew line.
privacybooleanNem
auto_renewbooleanNem
availability_tokenstringNemThe 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_codestringNemThe 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_routeRegistrationRouteKeyNemWhich 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 | nullNemRequired for a `hosting_plan` line — the immutable plan version to bill.
listing_package_idUuid | nullNemRequired 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…
intervalBillingIntervalNemThe recurrence a price is quoted for.
regionstringNemThe 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…
computeComputeLineConfigNemHow 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…
databaseDatabaseLineConfigNemThe 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…

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<open, checking_out, converted, abandoned, expired>Igen
currencyCurrencyCode | nullNemFixed 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_lineobjectNem
linesCartLine[]Igen
subtotalMoneyAmountIgenA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
discountMoneyAmountIgenA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
totalMoneyAmountIgenA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
created_atstringIgen
updated_atstringNem

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429