commerce

POST /v1/carts/{cartId}/lines

Add a line to a cart.

כל נקודות הקצה מסוג commerce

כל תיעוד המפתחים

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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 הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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