public
POST /v1/public/promo-codes/quote
Preview what a discount code takes off a guest basket.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/public/promo-codes/quote \
-H "Content-Type: application/json" \
-d '{ "code": <string>, "currency": <CurrencyCode>, "items": <CouponQuoteItem[]> }'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
The guest checkout's coupon preview (docs/1311). Unauthenticated and budgeted per visitor (a few dozen checks an hour, fail-closed). A DISPLAY only: the code is re-checked by publicCheckout before any account exists and the placed order is priced from the cart. Once-per-customer is judged at placement, against the new organization.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
code | string | Yes | — |
currency | CurrencyCode | Yes | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
org_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
items | CouponQuoteItem[] | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
code | string | Yes | — |
valid | boolean | Yes | — |
reason | CouponReason | Yes | Why a code does not apply (null when it does). Stable values the surfaces translate. |
message | object | No | — |
kind | object | No | — |
percent_off | object | No | — |
amount_off_minor | object | No | — |
amount_off_currency | object | No | — |
scope | object | No | — |
currency | string | Yes | — |
items | object[] | Yes | — |
discount_total_minor | integer | Yes | — |
Errors this endpoint can return
422 · 429