Skip to main content
Versionv1

External Ticketing API (0.1)

Download OpenAPI specification:Download

Integrate your own systems with CM.com Ticketing. Use this API to manage your events, read products, channels and payment methods, create and complete orders, look up the tickets issued to your customers, and set up discount campaigns and marketing trackers.

Authentication. Every request must carry your system token in the X-CM-SSO-ACCOUNTGUID header. A request with a missing or unknown token is answered with 401; a token that is not allowed to perform the request is answered with 403. You only ever see and change data that belongs to your own organisation.

Rate limiting. Each organisation may send up to 120 requests per minute, with short bursts of up to 30 requests. Requests over the limit are answered with 429 and the error code rate_limit_exceeded; wait a moment and retry.

Pagination. List endpoints accept skip and take (default take is 100) and return items, total_items, page_size and links (self, first, prev, next, last) so you can walk through the results.

Errors. Errors from the API itself are returned as JSON with a machine-readable error_code and a human-readable error_msg; switch on error_code in your code, as error_msg may change. (Authentication failures, 401 and 403, are returned as plain text.)

Webhooks. Register webhook endpoints, and choose which message types they receive, in the CM.com Ticketing dashboard. Messages are sent as a JSON POST with the message type in the X-Message-Type header, and identify the resource that changed; fetch its current state from this API. Respond with 2xx within 10 seconds. Failed deliveries are retried, so the same message may arrive more than once.

Webhooks

Webhook — customer_product.canceled Webhook

Sent when a customer product (an individual ticket) is canceled, either on its own or as part of an order cancellation. Retrieve it with GET /events/{event_id}/orders/{order_id}/products/{customer_product_id}.

header Parameters
X-Message-Type
required
string

Always customer_product.canceled

Request Body schema: application/json
required

Message payload

customer_product_id
string

UUID of the customer product. Present only when entity == "customer_product".

entity
string

Resource the message is about. One of: order, customer_product.

event_id
string

UUID of the ticketing event the resource belongs to.

order_id
string

UUID of the order the resource belongs to.

Responses

Request samples

Content type
application/json
{
  • "customer_product_id": "f23c8ad2-9b5b-4f7e-9a55-7c5c4c8b71d2",
  • "entity": "order",
  • "event_id": "3e2af7d0-7c1f-4d40-9b62-2fcb6e0d2c8a",
  • "order_id": "a76d9c1c-1bd6-4f6b-8a3e-5a9d9c8a1b54"
}

Response samples

Content type
application/json
{ }

Webhook — order.canceled Webhook

Sent when an order is canceled, followed by a customer_product.canceled message for each ticket in the order.

header Parameters
X-Message-Type
required
string

Always order.canceled

Request Body schema: application/json
required

Message payload

customer_product_id
string

UUID of the customer product. Present only when entity == "customer_product".

entity
string

Resource the message is about. One of: order, customer_product.

event_id
string

UUID of the ticketing event the resource belongs to.

order_id
string

UUID of the order the resource belongs to.

Responses

Request samples

Content type
application/json
{
  • "customer_product_id": "f23c8ad2-9b5b-4f7e-9a55-7c5c4c8b71d2",
  • "entity": "order",
  • "event_id": "3e2af7d0-7c1f-4d40-9b62-2fcb6e0d2c8a",
  • "order_id": "a76d9c1c-1bd6-4f6b-8a3e-5a9d9c8a1b54"
}

Response samples

Content type
application/json
{ }

Webhook — order.completed Webhook

Sent when an order is completed. Retrieve it with GET /events/{event_id}/orders/{order_id}.

header Parameters
X-Message-Type
required
string

Always order.completed

Request Body schema: application/json
required

Message payload

customer_product_id
string

UUID of the customer product. Present only when entity == "customer_product".

entity
string

Resource the message is about. One of: order, customer_product.

event_id
string

UUID of the ticketing event the resource belongs to.

order_id
string

UUID of the order the resource belongs to.

Responses

Request samples

Content type
application/json
{
  • "customer_product_id": "f23c8ad2-9b5b-4f7e-9a55-7c5c4c8b71d2",
  • "entity": "order",
  • "event_id": "3e2af7d0-7c1f-4d40-9b62-2fcb6e0d2c8a",
  • "order_id": "a76d9c1c-1bd6-4f6b-8a3e-5a9d9c8a1b54"
}

Response samples

Content type
application/json
{ }

Customer products

List customer products for the organisation

Returns all customer products (the individual tickets and other products issued to customers) across all of your events. Accepts the same filters as the event-level list.

Authorizations:
SystemTokenAuth
query Parameters
skip
integer

Number of items to skip (default 0)

take
integer

Page size (default 100)

product_type
string

Only return customer products of this product type

status
string

Only return customer products with this status

product_id
Array of strings

Only return customer products of this product (UUID). Repeat the parameter to include several products

issued_at_from
string

Only return customer products whose order was completed at or after this time (RFC 3339)

issued_at_to
string

Only return customer products whose order was completed at or before this time (RFC 3339)

refunded_at_from
string

Only return customer products whose order was refunded at or after this time (RFC 3339)

refunded_at_to
string

Only return customer products whose order was refunded at or before this time (RFC 3339)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    },
  • "page_size": 0,
  • "total_items": 0
}

List customer products for an event

Returns all customer products (the individual tickets and other products issued to customers) of one event.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

query Parameters
skip
integer

Number of items to skip (default 0)

take
integer

Page size (default 100)

product_type
string

Only return customer products of this product type

status
string

Only return customer products with this status

product_id
Array of strings

Only return customer products of this product (UUID). Repeat the parameter to include several products

issued_at_from
string

Only return customer products whose order was completed at or after this time (RFC 3339)

issued_at_to
string

Only return customer products whose order was completed at or before this time (RFC 3339)

refunded_at_from
string

Only return customer products whose order was refunded at or after this time (RFC 3339)

refunded_at_to
string

Only return customer products whose order was refunded at or before this time (RFC 3339)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    },
  • "page_size": 0,
  • "total_items": 0
}

List customer products for an order

Returns the customer products (the individual tickets and other products issued to the customer) of one order. Accepts the same filters as the event-level and organisation-level lists.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

order_id
required
string

Order ID (UUID)

query Parameters
skip
integer

Number of items to skip (default 0)

take
integer

Page size (default 100)

product_type
string

Only return customer products of this product type (for example ENTRANCE_TICKET)

status
string

Only return customer products with this status (for example ISSUED, RESERVED or REFUNDED)

product_id
Array of strings

Only return customer products of this product (UUID). Repeat the parameter to include several products

issued_at_from
string

Only return customer products whose order was completed at or after this time (RFC 3339)

issued_at_to
string

Only return customer products whose order was completed at or before this time (RFC 3339)

refunded_at_from
string

Only return customer products whose order was refunded at or after this time (RFC 3339)

refunded_at_to
string

Only return customer products whose order was refunded at or before this time (RFC 3339)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    },
  • "page_size": 0,
  • "total_items": 0
}

View customer product

Returns the details of one customer product (an individual ticket or other product issued to a customer): the customer's details, the product, the event and venue, the seat (null for events without seating), how often and when it was last scanned, and the tracking parameters of the order it belongs to.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

order_id
required
string

Order ID (UUID)

customer_product_id
required
string

Customer product ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "barcode_id": "string",
  • "canceled_at": "string",
  • "created_at": "string",
  • "currency_id": "string",
  • "customer_data": {
    },
  • "event": {
    },
  • "expire_at": "string",
  • "external_barcode_id": "string",
  • "last_scanned_at": "string",
  • "order_id": "string",
  • "personalized_at": "string",
  • "price_incl_vat": 0,
  • "price_with_discount_incl_vat": 0,
  • "product": {
    },
  • "scan_count": 0,
  • "seat": {
    },
  • "status": "string",
  • "tracking_parameters": [
    ],
  • "used_access_key_id": "string",
  • "used_discount_code_external_id": "string",
  • "used_discount_code_id": "string",
  • "uuid": "string",
  • "venue": {
    }
}

Cancel customer product

Cancels one customer product (an individual ticket or other product issued to a customer). Its barcode can no longer be used for entry and the product's stock is increased by one. The order it belongs to is not changed, and no refund is made. Canceling a customer product that is already canceled returns 409.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

order_id
required
string

Order ID (UUID)

customer_product_id
required
string

Customer product ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "barcode_id": "string",
  • "canceled_at": "string",
  • "created_at": "string",
  • "currency_id": "string",
  • "customer_data": {
    },
  • "event": {
    },
  • "expire_at": "string",
  • "external_barcode_id": "string",
  • "last_scanned_at": "string",
  • "order_id": "string",
  • "personalized_at": "string",
  • "price_incl_vat": 0,
  • "price_with_discount_incl_vat": 0,
  • "product": {
    },
  • "scan_count": 0,
  • "seat": {
    },
  • "status": "string",
  • "tracking_parameters": [
    ],
  • "used_access_key_id": "string",
  • "used_discount_code_external_id": "string",
  • "used_discount_code_id": "string",
  • "uuid": "string",
  • "venue": {
    }
}

Events

List events

Returns your organisation's active events.

Authorizations:
SystemTokenAuth
query Parameters
skip
integer

Number of items to skip (default 0)

take
integer

Page size (default 100)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    },
  • "page_size": 0,
  • "total_items": 0
}

Create event

Creates a new event. description and discount_label are objects keyed by language code (for example {"en": "...", "nl": "..."}); provide them for the languages you list in languages.

Authorizations:
SystemTokenAuth
Request Body schema: application/json
required

Event payload

object
object
downloadable_from
string
end_at
string
is_active
boolean
is_downloadable
boolean
is_order_invoice_enabled
boolean
is_personalization_enabled
boolean
is_visible
boolean
Array of objects
minutes_to_order
integer
name
string
online_from
string
online_till
string
short_id
string
start_at
string
object
type
string
Enum: "GENERAL_ADMISSION" "SEATED"
object

Responses

Request samples

Content type
application/json
{
  • "description": {
    },
  • "discount_label": {
    },
  • "downloadable_from": "string",
  • "end_at": "string",
  • "is_active": true,
  • "is_downloadable": true,
  • "is_order_invoice_enabled": true,
  • "is_personalization_enabled": true,
  • "is_visible": true,
  • "languages": [
    ],
  • "minutes_to_order": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "short_id": "string",
  • "start_at": "string",
  • "timezone": {
    },
  • "type": "GENERAL_ADMISSION",
  • "venue": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": {
    },
  • "discount_label": {
    },
  • "downloadable_from": "string",
  • "end_at": "string",
  • "id": "string",
  • "is_active": true,
  • "is_downloadable": true,
  • "is_order_invoice_enabled": true,
  • "is_personalization_enabled": true,
  • "is_visible": true,
  • "languages": [
    ],
  • "minutes_to_order": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "short_id": "string",
  • "start_at": "string",
  • "timezone": {
    },
  • "type": "string",
  • "updated_at": "string",
  • "venue": {
    }
}

Delete event

Deactivates an event: it is not removed, but is_active becomes false. Calling this on an event that is already inactive also returns 204.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "error_code": "string",
  • "error_msg": "string"
}

View event

Returns the details of one event, including its description and discount label in every language they are available in.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": {
    },
  • "discount_label": {
    },
  • "downloadable_from": "string",
  • "end_at": "string",
  • "id": "string",
  • "is_active": true,
  • "is_downloadable": true,
  • "is_order_invoice_enabled": true,
  • "is_personalization_enabled": true,
  • "is_visible": true,
  • "languages": [
    ],
  • "minutes_to_order": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "short_id": "string",
  • "start_at": "string",
  • "timezone": {
    },
  • "type": "string",
  • "updated_at": "string",
  • "venue": {
    }
}

Edit event

Replaces all editable fields of an event. This is a full replacement, not a partial update: send the complete event as you want it to be stored. Fields you leave out or set to null, and arrays you send empty, are cleared.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Request Body schema: application/json
required

Event payload

object
object
downloadable_from
string
end_at
string
is_active
boolean
is_downloadable
boolean
is_order_invoice_enabled
boolean
is_personalization_enabled
boolean
is_visible
boolean
Array of objects
minutes_to_order
integer
name
string
online_from
string
online_till
string
short_id
string
start_at
string
object
type
string
Enum: "GENERAL_ADMISSION" "SEATED"
object

Responses

Request samples

Content type
application/json
{
  • "description": {
    },
  • "discount_label": {
    },
  • "downloadable_from": "string",
  • "end_at": "string",
  • "is_active": true,
  • "is_downloadable": true,
  • "is_order_invoice_enabled": true,
  • "is_personalization_enabled": true,
  • "is_visible": true,
  • "languages": [
    ],
  • "minutes_to_order": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "short_id": "string",
  • "start_at": "string",
  • "timezone": {
    },
  • "type": "GENERAL_ADMISSION",
  • "venue": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": {
    },
  • "discount_label": {
    },
  • "downloadable_from": "string",
  • "end_at": "string",
  • "id": "string",
  • "is_active": true,
  • "is_downloadable": true,
  • "is_order_invoice_enabled": true,
  • "is_personalization_enabled": true,
  • "is_visible": true,
  • "languages": [
    ],
  • "minutes_to_order": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "short_id": "string",
  • "start_at": "string",
  • "timezone": {
    },
  • "type": "string",
  • "updated_at": "string",
  • "venue": {
    }
}

Channels

List channels

Returns the active sales channels of an event. Each channel has a public shop url that you can link your customers to.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

query Parameters
skip
integer

Number of items to skip (default 0)

take
integer

Page size (default 100)

sort
string
Enum: "created_at" "slug"

Field to sort by

order
string
Enum: "asc" "desc"

Sort direction

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    },
  • "page_size": 0,
  • "total_items": 0
}

Discounts

Create discount campaign

Creates a discount campaign for an event. Set discount_type to choose the kind of discount. With ORDER, the discount applies to the whole order: provide a rate, a rate_type (MONETARY or PERCENTAGE) and the discount_code your customers will enter. With PRODUCT, the discount applies to specific products: provide discount_campaign_products with a product_uuid, max_usage, rate and currency_id for each product (each rate_type must be MONETARY); the discount code is generated for you. The response contains the campaign id, the discount_code (the one you supplied for ORDER, the generated one for PRODUCT) and the rate, or the per-product entries.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Request Body schema: application/json
required

Discount payload

currency_id
string
Array of objects (handler.createDiscountRequestProduct)

Only for PRODUCT campaigns.

discount_code
string

Only for ORDER campaigns.

discount_type
string

ORDER (discount on the whole order) or PRODUCT (discount on specific products)

max_usage
integer
name
string
online_from
string
online_till
string
rate
number
rate_type
string

Responses

Request samples

Content type
application/json
{
  • "currency_id": "string",
  • "discount_campaign_products": [
    ],
  • "discount_code": "string",
  • "discount_type": "string",
  • "max_usage": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "rate": 0,
  • "rate_type": "string"
}

Response samples

Content type
application/json
{
  • "currency_id": "string",
  • "discount_campaign_products": [
    ],
  • "discount_code": "string",
  • "discount_type": "string",
  • "id": "string",
  • "max_usage": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "rate": 0,
  • "rate_type": "string"
}

Update discount campaign

Updates the name, max_usage, online_from and online_till of a discount campaign. The rate, currency, discount code and per-product entries cannot be changed after the campaign is created; to change them, create a new campaign. The response has the same shape as the create response.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

discount_id
required
string

Discount campaign ID (UUID)

Request Body schema: application/json
required

Fields to update

max_usage
integer
name
string
online_from
string
online_till
string

Responses

Request samples

Content type
application/json
{
  • "max_usage": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string"
}

Response samples

Content type
application/json
{
  • "currency_id": "string",
  • "discount_campaign_products": [
    ],
  • "discount_code": "string",
  • "discount_type": "string",
  • "id": "string",
  • "max_usage": 0,
  • "name": "string",
  • "online_from": "string",
  • "online_till": "string",
  • "rate": 0,
  • "rate_type": "string"
}

Marketing Trackers

List marketing trackers

Returns the marketing trackers of an event, grouped by channel (shop). Each group has totals for clicks, orders and tickets sold, and lists its trackers with their own statistics and the tracking link to share.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create marketing tracker

Creates a marketing tracker for one of your event's channels (shops). Pass the channel's uuid, as returned by GET /events/{event_id}/channels, as viewport_uuid. The tracker gets its own tracking link, so you can see how many clicks, orders and tickets each promotion brings in. Supported channels are INSTAGRAM, FACEBOOK, TIKTOK, WHATSAPP, NEWSLETTER, X, SHOPIFY and OTHER. The SPOTIFY and AUTOMATED_EMAIL channels are managed by CM.com and cannot be created here.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Request Body schema: application/json
required

Marketing tracker payload

channel
string
name
string
viewport_uuid
string

Responses

Request samples

Content type
application/json
{
  • "channel": "string",
  • "name": "string",
  • "viewport_uuid": "string"
}

Response samples

Content type
application/json
{
  • "channel": "string",
  • "clicks": 0,
  • "created_at": "string",
  • "deliveries": 0,
  • "event_uuid": "string",
  • "id": "string",
  • "name": "string",
  • "orders": 0,
  • "products": 0,
  • "viewport_uuid": "string"
}

Delete marketing tracker

Deletes a marketing tracker. Only trackers that you created can be deleted; the SPOTIFY and AUTOMATED_EMAIL trackers are managed by CM.com and cannot be deleted.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

tracker_id
required
string

Marketing Tracker ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "error_code": "string",
  • "error_msg": "string"
}

Orders

List orders

Returns the orders of an event, optionally filtered by status, product, sales origin or completion time.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

query Parameters
skip
integer

Number of items to skip (default 0)

take
integer

Page size (default 100)

status
string
Enum: "COMPLETED" "CANCELED" "REFUNDED" "RELEASED" "PENDING"

Only return orders with this status

product_id
Array of strings

Only return orders that contain this product (UUID). Repeat the parameter to match orders containing any of several products

sales_origin
string

Only return orders created through this sales origin: SHOP (the online shop), BACKOFFICE or PARTNER_API (orders created through this API)

completed_at_from
string

Only return orders completed at or after this time (RFC 3339)

completed_at_to
string

Only return orders completed at or before this time (RFC 3339)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    },
  • "page_size": 0,
  • "total_items": 0
}

Create order

Creates an order for an event. There are two ways to use it. With complete=true the order is completed immediately, using the payment_method and delivery_method in the same request. With complete=false (the default) the order is created with status PENDING and reserves the requested tickets; you then finish it with PUT /events/{event_id}/orders/{order_id}/complete, or release the tickets with PUT /events/{event_id}/orders/{order_id}/cancel. The response has the same shape as GET /events/{event_id}/orders/{order_id}. Use external_batch_id to store your own reference for the order.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Request Body schema: application/json
required

Order payload

complete
boolean
object (handler.createOrderCustomerData)
delivery_method
string
Enum: "NONE" "EMAIL"
external_batch_id
string
payment_method
string
Enum: "FREE" "EXTERNAL_PAYMENT"
Array of objects (handler.createOrderTicket)

Responses

Request samples

Content type
application/json
{
  • "complete": true,
  • "customer_data": {
    },
  • "delivery_method": "NONE",
  • "external_batch_id": "string",
  • "payment_method": "FREE",
  • "tickets": [
    ]
}

Response samples

Content type
application/json
{
  • "batch_id": "string",
  • "canceled_at": "string",
  • "completed_at": "string",
  • "consents": [
    ],
  • "currency_id": "string",
  • "customer_data": {
    },
  • "download_url": "string",
  • "external_batch_id": "string",
  • "is_guest_list_order": true,
  • "payment_method": "string",
  • "personalized_at": "string",
  • "refunded_at": "string",
  • "requested_language_id": "string",
  • "status": "string",
  • "tickets": [
    ],
  • "total_balance": 0,
  • "uuid": "string"
}

View order

Returns the details of one order: its status, the customer's details, the payment method, the tickets that were ordered and the consents the customer gave.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

order_id
required
string

Order ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "batch_id": "string",
  • "canceled_at": "string",
  • "completed_at": "string",
  • "consents": [
    ],
  • "currency_id": "string",
  • "customer_data": {
    },
  • "download_url": "string",
  • "external_batch_id": "string",
  • "is_guest_list_order": true,
  • "payment_method": "string",
  • "personalized_at": "string",
  • "refunded_at": "string",
  • "requested_language_id": "string",
  • "status": "string",
  • "tickets": [
    ],
  • "total_balance": 0,
  • "uuid": "string"
}

Cancel order

Cancels an order that is still PENDING and makes the tickets it reserved available again. This endpoint does not refund or cancel completed orders; to cancel individual tickets of a completed order, use the customer product cancel endpoint. Canceling an order that is already canceled returns 409.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

order_id
required
string

Order ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "batch_id": "string",
  • "canceled_at": "string",
  • "completed_at": "string",
  • "consents": [
    ],
  • "currency_id": "string",
  • "customer_data": {
    },
  • "download_url": "string",
  • "external_batch_id": "string",
  • "is_guest_list_order": true,
  • "payment_method": "string",
  • "personalized_at": "string",
  • "refunded_at": "string",
  • "requested_language_id": "string",
  • "status": "string",
  • "tickets": [
    ],
  • "total_balance": 0,
  • "uuid": "string"
}

Complete order

Completes an order that was created with complete=false and is still PENDING. If you leave out payment_method it defaults to FREE, and if you leave out delivery_method it defaults to NONE. Completing an order that is already completed returns 409.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

order_id
required
string

Order ID (UUID)

Request Body schema: application/json
required

Complete order payload

delivery_method
string
Enum: "NONE" "EMAIL"
mark_as_scanned
boolean
payment_method
string
Enum: "FREE" "EXTERNAL_PAYMENT"

Responses

Request samples

Content type
application/json
{
  • "delivery_method": "NONE",
  • "mark_as_scanned": true,
  • "payment_method": "FREE"
}

Response samples

Content type
application/json
{
  • "batch_id": "string",
  • "canceled_at": "string",
  • "completed_at": "string",
  • "consents": [
    ],
  • "currency_id": "string",
  • "customer_data": {
    },
  • "download_url": "string",
  • "external_batch_id": "string",
  • "is_guest_list_order": true,
  • "payment_method": "string",
  • "personalized_at": "string",
  • "refunded_at": "string",
  • "requested_language_id": "string",
  • "status": "string",
  • "tickets": [
    ],
  • "total_balance": 0,
  • "uuid": "string"
}

Payment methods

List payment methods

Returns the payment methods that are enabled for an event and available to online customers. Box-office-only payment methods are not included.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products

List products

Returns the active products (for example tickets) of an event, with their name in each language and their price.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

query Parameters
skip
integer

Number of items to skip (default 0)

take
integer

Page size (default 100)

sort
string
Enum: "display_order" "name" "created_at"

Field to sort by

order
string
Enum: "asc" "desc"

Sort direction

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": {
    },
  • "page_size": 0,
  • "total_items": 0
}

View product

Returns the details of one product, including its remaining stock (reported as 0 when has_unlimited_stock is true) and the capacity of the pool it draws from, which can be shared with other products.

Authorizations:
SystemTokenAuth
path Parameters
event_id
required
string

Event ID (UUID)

product_id
required
string

Product ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "additional_information": {
    },
  • "capacity": 0,
  • "description": {
    },
  • "external_id_1": "string",
  • "external_id_2": "string",
  • "external_id_3": "string",
  • "has_unlimited_stock": true,
  • "is_personalizable": true,
  • "is_visible": true,
  • "name": {
    },
  • "price": 0,
  • "product_type": "string",
  • "sales_from": "string",
  • "sales_until": "string",
  • "stock": 0,
  • "subtitle": {
    },
  • "ticket_status_type_id": "string",
  • "uuid": "string",
  • "valid_from": "string",
  • "valid_until": "string"
}