Coupons

By issuing coupons you can allow ticket buyers to receive a discount on their transaction by applying a randomly generated or custom-defined code to their cart.

Endpoints

The Coupon Object

Attributes

One of

Only one of the following types

couponType

Required

string

couponSeries

couponSeriesId

Required

string

The ID of the coupon series.

Optional Attributes

Collapse all

_id

Optional

string

The ID of the coupon.

code

Optional

string

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

sellerId

Optional

string

The ID of the seller.

customer

Optional

string

The customer that this promotion code can be used by.

createdAt

Optional

string date-time

The date the coupon was created.

updatedAt

Optional

string date-time

The date the coupon was last updated.

__v

Optional

integer

Was this section helpful?

Yes No

{
  "couponType": "couponSeries",
  "couponSeriesId": "string",
  "_id": "string",
  "code": "string",
  "sellerId": "string",
  "customer": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Create a Coupon

Payload

One of

Only one of the following types

couponType

Required

string

couponSeries

couponSeriesId

Required

string

The ID of the coupon series.

Optional Attributes

Collapse all

code

Optional

string

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

sellerId

Optional

string

The ID of the seller.

customer

Optional

string

The customer that this promotion code can be used by.

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "couponType": "couponSeries",
  "couponSeriesId": "string",
  "code": "string",
  "sellerId": "string",
  "customer": "string"
}

{
  "couponType": "couponSeries",
  "couponSeriesId": "string",
  "_id": "string",
  "code": "string",
  "sellerId": "string",
  "customer": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Get a Coupon

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "couponType": "couponSeries",
  "couponSeriesId": "string",
  "_id": "string",
  "code": "string",
  "sellerId": "string",
  "customer": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Update a Coupon

Payload

One of

Only one of the following types

couponType

Required

string

couponSeries

couponSeriesId

Required

string

The ID of the coupon series.

Optional Attributes

Collapse all

_id

Optional

string

The ID of the coupon.

code

Optional

string

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

sellerId

Optional

string

The ID of the seller.

customer

Optional

string

The customer that this promotion code can be used by.

createdAt

Optional

string date-time

The date the coupon was created.

updatedAt

Optional

string date-time

The date the coupon was last updated.

__v

Optional

integer

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "couponType": "couponSeries",
  "couponSeriesId": "string",
  "_id": "string",
  "code": "string",
  "sellerId": "string",
  "customer": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

{
  "couponType": "couponSeries",
  "couponSeriesId": "string",
  "_id": "string",
  "code": "string",
  "sellerId": "string",
  "customer": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

This endpoint provides information on both coupons and vouchers. To receive a coupon, you need to pass an eventId, even if the coupon can be used across all events. If there is a coupon and a voucher with the same code, and you pass an eventId, the coupon will be preferred. Without passing an eventId, only vouchers will be considered.

Query

sellerId

Required

string

The ID of the seller

eventId

Optional

string

The ID of the event to check the coupon/voucher against.

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "message": "notYetValid",
  "coupon": {
    "code": "string",
    "couponId": "string",
    "name": "string",
    "canBeCombined": true,
    "discountType": "fix",
    "discountValue": 10.5,
    "discountMaxValue": 10.5,
    "allowAllTickets": true,
    "allowedTickets": [
      "string"
    ],
    "allowAllEvents": true,
    "limitMaxTicketsInCart": true,
    "maxTicketsInCart": 10.5,
    "maxTickets": 10.5,
    "revealAllowedTickets": true
  },
  "voucher": {
    "_id": "string",
    "code": "string",
    "balance": 10.5
  },
  "type": "voucher"
}

The Coupon Series Object

The Coupon Series feature allows for the generation of multiple coupon codes with a single configuration. This is beneficial for creating promotions where each coupon code shares identical settings or restrictions, all managed with a single coupon series.

Attributes

name

Required

string

The Name for the coupon. Visible to public.

_id

Required

string

The ID of the coupon series.

sellerId

Required

string

The ID of the seller.

Optional Attributes

Collapse all

singleUsage

Optional

boolean

Whether this coupon can only be used once

active

Optional

boolean

Whether the coupon can be used

maxUsage

Optional

number float

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

maxUsagePerEvent

Optional

number float

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

maxTickets

Optional

number float

The number of tickets that can be purchased with this coupon

canBeCombined

Optional

boolean

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

discountType

Optional

string

fixvarfixPerItem

discountValue

Optional

number float

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

discountMaxValue

Optional

number float

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

allowAllEvents

Optional

boolean

Whether the coupon can be used across all events

allowedEvents

Optional

array<string>

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

allowAllTickets

Optional

boolean

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

allowedTickets

Optional

array<string>

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

taggingEnabled

Optional

boolean

Whether this coupon tags customers

Create coupon series

Payload

name

Required

string

The Name for the coupon. Visible to public.

sellerId

Required

string

The ID of the seller.

Optional Attributes

Collapse all

singleUsage

Optional

boolean

Whether this coupon can only be used once

active

Optional

boolean

Whether the coupon can be used

maxUsage

Optional

number float

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

maxUsagePerEvent

Optional

number float

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

maxTickets

Optional

number float

The number of tickets that can be purchased with this coupon

canBeCombined

Optional

boolean

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

discountType

Optional

string

fixvarfixPerItem

discountValue

Optional

number float

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

discountMaxValue

Optional

number float

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

allowAllEvents

Optional

boolean

Whether the coupon can be used across all events

allowedEvents

Optional

array<string>

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

allowAllTickets

Optional

boolean

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

allowedTickets

Optional

array<string>

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

taggingEnabled

Optional

boolean

Whether this coupon tags customers

Get all coupon series

Query

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

name

Optional

string

Filter coupon series by name

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "name": "string",
    "singleUsage": true,
    "active": true,
    "maxUsage": 1,
    "maxUsagePerEvent": 10.5,
    "maxTickets": 10.5,
    "canBeCombined": true,
    "discountType": "fix",
    "discountValue": 10.5,
    "discountMaxValue": 10.5,
    "allowAllEvents": true,
    "allowedEvents": [
      "string"
    ],
    "allowAllTickets": true,
    "allowedTickets": [
      "string"
    ],
    "taggingEnabled": true,
    "tags": [
      "string"
    ],
    "validFrom": "2030-01-23T23:00:00.123Z",
    "validUntil": "2030-01-23T23:00:00.123Z",
    "limitMaxTicketsInCart": true,
    "maxTicketsInCart": 10.5,
    "note": "string",
    "revealAllowedTickets": true,
    "unlocks": [
      {
        "target": "underShop",
        "eventId": "string",
        "underShopId": "string"
      }
    ],
    "_id": "string",
    "sellerId": "string",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]

Get a coupon series

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "name": "string",
  "singleUsage": true,
  "active": true,
  "maxUsage": 1,
  "maxUsagePerEvent": 10.5,
  "maxTickets": 10.5,
  "canBeCombined": true,
  "discountType": "fix",
  "discountValue": 10.5,
  "discountMaxValue": 10.5,
  "allowAllEvents": true,
  "allowedEvents": [
    "string"
  ],
  "allowAllTickets": true,
  "allowedTickets": [
    "string"
  ],
  "taggingEnabled": true,
  "tags": [
    "string"
  ],
  "validFrom": "2030-01-23T23:00:00.123Z",
  "validUntil": "2030-01-23T23:00:00.123Z",
  "limitMaxTicketsInCart": true,
  "maxTicketsInCart": 10.5,
  "note": "string",
  "revealAllowedTickets": true,
  "unlocks": [
    {
      "target": "underShop",
      "eventId": "string",
      "underShopId": "string"
    }
  ],
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update coupon series

Payload

name

Required

string

The Name for the coupon. Visible to public.

_id

Required

string

The ID of the coupon series.

sellerId

Required

string

The ID of the seller.

Optional Attributes

Collapse all

singleUsage

Optional

boolean

Whether this coupon can only be used once

active

Optional

boolean

Whether the coupon can be used

maxUsage

Optional

number float

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

maxUsagePerEvent

Optional

number float

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

maxTickets

Optional

number float

The number of tickets that can be purchased with this coupon

canBeCombined

Optional

boolean

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

discountType

Optional

string

fixvarfixPerItem

discountValue

Optional

number float

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

discountMaxValue

Optional

number float

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

allowAllEvents

Optional

boolean

Whether the coupon can be used across all events

allowedEvents

Optional

array<string>

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

allowAllTickets

Optional

boolean

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

allowedTickets

Optional

array<string>

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

taggingEnabled

Optional

boolean

Whether this coupon tags customers

Coupons

Endpoints

The Coupon Object

Attributes

Optional Attributes

Create a Coupon

Payload

Optional Attributes

Get a Coupon

Query

Update a Coupon

Payload

Optional Attributes

Get all Coupons

Query

Get Coupon or Voucher by code

Query

The Coupon Series Object

Attributes

Optional Attributes

Create coupon series

Payload

Optional Attributes

Get all coupon series

Query

Get a coupon series

Query

Update coupon series

Payload

Optional Attributes