latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api
coupons

Decouple coupon from coupon series

post/api/coupon/{id}/decouple

Path parameters

idstring required

Response

OK

couponType'coupon'
_idstring

The ID of the coupon.

codestring nullable

A random generated 8 char code use to redeem the coupon.

sellerIdstring

The ID of the seller.

customerstring nullable

The customer that this promotion code can be used by.

createdAtstring date-time

The date the coupon was created.

updatedAtstring date-time

The date the coupon was last updated.

__vinteger
namestring required

The Name for the coupon. Visible to public.

singleUsageboolean

Whether this coupon can only be used once

activeboolean

Whether the coupon can be used

maxUsagenumber float

The max amount of usages. A usage is counted as a completed transaction that used the coupon.

maxUsagePerEventnumber float nullable

The max amount of usages per event. A usage is counted as a completed transaction that used the coupon.

maxTicketsnumber float nullable

The number of tickets that can be purchased with this coupon

canBeCombinedboolean

Whether this coupon can be combined with others within one transaction.

discountType'fix' | 'var' | 'fixPerItem' | 'waiveFees'
discountValuenumber float

The amount of the discount in seller's currency. eg. 50.0 -> 50 EUR

discountMaxValuenumber float nullable

When discountType is VAR the max amount of the discount in seller's currency

allowAllEventsboolean

Whether the coupon can be used across all events

allowedEventsstring[]

The ID's of events where the coupon can be used

allowAllTicketsboolean

Whether the coupon can be used across all tickets within the events

allowedTicketsstring[]

The ID's of the ticket types on which the coupon should be applied

taggingEnabledboolean

Whether this coupon tags customers

tagsstring[]

Which tags to add to customers which bought with this coupon

validFromstring date-time nullable

The date from which this coupon can be redeemed.

validUntilstring date-time nullable

The date until this coupon can be redeemed.

limitMaxTicketsInCartboolean

Whether this coupon limits the max tickets in cart.

maxTicketsInCartnumber float nullable

If limitMaxTicketsInCart is true, the amount of the max allowed tickets.

minTicketsInCartnumber float nullable

The minimum number of tickets that need to be purchased with this coupon

notestring nullable

The Note for this coupon.

revealAllowedTicketsboolean

Whether this coupon reveals the allowed tickets.