Catalog

Update a coupon's name, metadata or active flag (terms are immutable)

Update a coupon's name, metadata or active flag (terms are immutable). Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

patch/api/v1/coupons/{id}

Request

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

Path parameters

idstring required

The resource identifier returned by the merchant API.

Headers

Idempotency-Keystring

Retry-safe key for create operations.

Request body

namestring nullable

activeboolean

metadataobject

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

Response

The updated coupon

idstring required

object'coupon' required

livemodeboolean required

createdAtstring date-time required

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 required

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

timesRedeemedinteger required

activeboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.