commerce

PUT /v1/carts/{cartId}/promo-code

Type a discount code into a cart.

All commerce endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The endpoint checks billing.payment.manage; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

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

curl -X PUT https://api.zinndigital.com/v1/carts/{cartId}/promo-code \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "code": <string> }'

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

Applies a hosting/SEO-tool coupon (docs/1311) to the basket. The saving is taken off the FIRST billing period of each eligible line only; renewals are never discounted, and VAT is computed on the discounted net at checkout. A code that cannot apply to this customer at all is a 422 whose details[0].code is one of not_found, inactive, not_started, expired, exhausted, already_used. A code that applies to nothing in the basket YET is accepted and reported on Cart.coupon.reason (not_eligible, currency_mismatch), because a customer may type it before choosing the plan. A domain promotion code is accepted here too and priced by the domain path.

Parameters

NameTypeRequiredWhat it is
cartId (path)UuidYesThe cart's id.

Request body

NameTypeRequiredWhat it is
codestringYes—

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).
promo_codeobjectNoThe discount code typed into this basket (docs/1311), or null.
couponCartCoupon | nullNoWhat the typed hosting/SEO coupon did to this basket, or null when no coupon code is typed (a domain promotion code is reported on its lines instead).
created_atstringYes—
updated_atstringNo—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429