認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 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, including…
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, because…
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, so…
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 this…
plan_version_idUuid | nullいいえRequired for a hosting_plan line — the immutable plan version to bill.
extra_codestringいいえThe catalogue code of the service an extra line buys. Required for that kind and meaningless on any other. Which addons a cart may buy is validated against…
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 amount…
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 means…
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 line…
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…

返信

名前タイプ必須これがその内容です
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いいえ

このエンドポイントが返すエラー

401 · 403 · 404 · 422 · 429