Catalog

Create a coupon

Create a coupon. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

post/api/v1/coupons

Request

Base URL
https://merchant.zahlo.eu
Auth
API key in header x-api-key

Headers

Idempotency-Keystring

Retry-safe key for create operations.

Request body

namestring nullable

percentOffnumber nullable

Set exactly one of percentOff and amountOffMinor.

amountOffMinorinteger nullable

currencystring nullable

Required with amountOffMinor.

duration'once' | 'repeating' | 'forever' required

durationInMonthsinteger nullable

Required for, and only for, duration repeating.

codestring nullable

Promotion code customers type; unique per merchant, case-insensitive.

maxRedemptionsinteger nullable

redeemBystring date-time nullable

metadataobject

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

Response

The coupon

idstring required

object'coupon' required

livemodeboolean required

createdAtstring date-time required