Tickets

The Ticket object represents an attendee for an event. Each Ticket has a Barcode for identification. Tickets are usually created when Transactions transition to completed.

Endpoints

The Ticket object

Attributes

_id

Required

string

sellerId

Required

string

The ID of the seller that ticket belongs to.

eventId

Required

string

The ID of the event the ticket belongs to

ticketTypeId

Required

string

The ID of the ticket type this ticket inherits from

ticketName

Required

string

The name of the ticket type this ticket inherits from

createdAt

Required

string date-time

An ISO Timestamp indicating when the ticket was created.

updatedAt

Required

string date-time

An ISO Timestamp indicating when the ticket was updated.

status

Required

string

The status of the ticket

VALIDINVALIDRESERVEDDETAILSREQUIREDBLANK

secret

Required

string

The secret token of the ticket

barcode

Required

string

The barcode of the ticket

Optional Attributes

Collapse all

company

Optional

string

Optional

string

name

Optional

string

The name of the ticket owner

firstname

Optional

string

The first name of the ticket owner

lastname

Optional

string

The last name of the ticket owner

street

Optional

string

line2

Optional

string

The additional address field of the user of the ticket

city

Optional

string

postal

Optional

string

state

Optional

string

The state of the user of the ticket

country

Optional

string

The country of the user of the ticket

rootEventId

Optional

string

The ID of the root event, if exists

transactionId

Optional

string

The transaction the ticket originated from

posId

Optional

string

The point of sale the ticket was created on

underShopId

Optional

string

The ID of an undershop the ticket was purchased through

categoryRef

Optional

string

A UUID of the category the ticket belongs to.

categoryName

Optional

string

The name of the category the ticket belongs to.

slotId

Optional

string

The ID of the time slot this ticket belongs to, if exists

cartItemId

Optional

string

The ID of the cart item to which the ticket belongs

triggeredBy

Optional

array<string>

An array of IDs of cart items which triggered the buy action of the ticket

currency

Optional

string

An ISO 4217 3-character code of the currency

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWD

regularPrice

Optional

number float

The original non discounted price for the ticket

realPrice

Optional

number float

The real price for the ticket

completed

Optional

boolean

Whether all steps for validating the ticket has been made

expiresAt

Optional

string date-time

An ISO Timestamp indicating when the ticket will be expired.

seat

Optional

string

seatingInfo

Optional

object

The associated seating object.

seatingInfo._type

Required

number float

Indicates the type of seating object. Seat = 6, General Admission = 7.

67

seatingInfo.statusId

Required

string

The ID of a container holding information about the seating status of the seating object.

Optional Attributes

Collapse all

seatingInfo._id

Optional

string

The ID of the seating object.

seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

seatingInfo.name

Optional

string

If _type == 7. The name of the general admission.

seatingInfo.seatType

Optional

string

If _type == 6. The type of the seat. null = normal.

handicapped

seatingInfo.sectionName

Optional

string

If _type == 6. The name of the section where the seat is located.

seatingInfo.groupName

Optional

string

If _type == 6. The name of the row group where the seat is located.

seatingInfo.rowName

Optional

string

If _type == 6. The name of the row where the seat is located.

seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

type

Optional

string

The type of the ticket

SINGLEMULTI

origin

Optional

string

yourticketposrebookingupgradetransfer

extraFields

Optional

object

A hashmap of extra fields for the ticket

batch

Optional

string

A UUId indicating in which batch the tickets were created

batchCounter

Optional

number float

A counter indicating the order of the ticket in the batch

deliveryType

Optional

string

The delivery type of the ticket

HARDVIRTUAL

readyForDelivery

Optional

boolean

Whether the ticket is ready for delivery

customMessage

Optional

string

priceCategoryId

Optional

string

entryPermissions

Optional

array

One of

Only one of the following types

customerId

Optional

string

history

Optional

array

One of

Only one of the following types

personalized

Optional

boolean

excludedEventIds

Optional

array<string>

An array of IDs of events for which the ticket has been blocked

originTicketId

Optional

string

The ID of the origin ticket from which the ticket created

fulfillmentTypeId

Optional

string

The ID of the fulfillment type used to deliver the ticket

__v

Optional

integer

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Create free Tickets

Payload

One of

Only one of the following types

eventId

Required

string

The ID of the event containing the ticket cart items.

items

Required

array

An array containing all ticket cart items.

items[].amount

Required

integer

The amount of the cart item.

items[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

items[]._id

Optional

string

The ID of the cart item.

items[].type

Optional

string

The type of the cart item.

ticket

items[].seatingInfo

Optional

object

The associated seating object.

items[].seatingInfo._type

Required

number float

Indicates the type of seating object. Seat = 6, General Admission = 7.

67

items[].seatingInfo.statusId

Required

string

The ID of a container holding information about the seating status of the seating object.

Optional Attributes

Collapse all

items[].seatingInfo._id

Optional

string

The ID of the seating object.

items[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

items[].seatingInfo.name

Optional

string

If _type == 7. The name of the general admission.

items[].seatingInfo.seatType

Optional

string

If _type == 6. The type of the seat. null = normal.

handicapped

items[].seatingInfo.sectionName

Optional

string

If _type == 6. The name of the section where the seat is located.

items[].seatingInfo.groupName

Optional

string

If _type == 6. The name of the row group where the seat is located.

items[].seatingInfo.rowName

Optional

string

If _type == 6. The name of the row where the seat is located.

items[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

items[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

items[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

items[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

items[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

items[].id

Optional

Deprecated

string

The ID of the ticket type of the cart item.

customerId

Required

string

The ID of the existing customer.

Optional Attributes

Collapse all

underShopId

Optional

string

sendMail

Optional

boolean

customMessage

Optional

string

requiresPersonalization

Optional

boolean

seatingReservationToken

Optional

string

batchId

Optional

string

salesChannelId

Optional

string

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "eventId": "string",
  "underShopId": "string",
  "items": [
    {
      "_id": "string",
      "type": "ticket",
      "amount": 1,
      "ticketTypeId": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "asHardTicket": true,
      "triggeredBy": "string",
      "triggeredAutomations": true,
      "id": "string"
    }
  ],
  "sendMail": true,
  "customMessage": "string",
  "requiresPersonalization": true,
  "seatingReservationToken": "string",
  "batchId": "string",
  "salesChannelId": "string",
  "customerId": "string"
}

[
  {
    "_id": "string",
    "sellerId": "string",
    "company": "string",
    "email": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "street": "string",
    "line2": "string",
    "city": "string",
    "postal": "string",
    "state": "string",
    "country": "string",
    "eventId": "string",
    "rootEventId": "string",
    "transactionId": "string",
    "posId": "string",
    "underShopId": "string",
    "categoryRef": "string",
    "categoryName": "string",
    "ticketTypeId": "string",
    "slotId": "string",
    "cartItemId": "string",
    "triggeredBy": [
      "string"
    ],
    "ticketName": "string",
    "currency": "EUR",
    "regularPrice": 10.5,
    "realPrice": 10.5,
    "completed": true,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "expiresAt": "2030-01-23T23:00:00.123Z",
    "status": "VALID",
    "secret": "string",
    "barcode": "string",
    "seat": "string",
    "seatingInfo": {
      "_id": "string",
      "_type": 6,
      "categoryId": "string",
      "statusId": "string",
      "name": "string",
      "seatType": "handicapped",
      "sectionName": "string",
      "groupName": "string",
      "rowName": "string",
      "seatName": "string",
      "gate": "string"
    },
    "type": "SINGLE",
    "origin": "yourticket",
    "extraFields": {},
    "batch": "string",
    "batchCounter": 10.5,
    "deliveryType": "HARD",
    "readyForDelivery": true,
    "customMessage": "string",
    "priceCategoryId": "string",
    "entryPermissions": [
      []
    ],
    "customerId": "string",
    "history": [
      []
    ],
    "personalized": true,
    "excludedEventIds": [
      "string"
    ],
    "originTicketId": "string",
    "fulfillmentTypeId": "string",
    "__v": 1
  }
]

Get a Ticket

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Update a Ticket

Payload

Optional Attributes

Collapse all

barcode

Optional

string

Ticket barcode

extraFields

Optional

object

Validate Ticket

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Require Details

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

PUBLIC

Invalidate Ticket

Query

secret

Optional

string

The secret of the ticket if you use the endpoint without authentication

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Reissue Ticket

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Invalidate Tickets of a Batch

Query

No supported query parameters

201

Created

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "sellerId": "string",
    "company": "string",
    "email": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "street": "string",
    "line2": "string",
    "city": "string",
    "postal": "string",
    "state": "string",
    "country": "string",
    "eventId": "string",
    "rootEventId": "string",
    "transactionId": "string",
    "posId": "string",
    "underShopId": "string",
    "categoryRef": "string",
    "categoryName": "string",
    "ticketTypeId": "string",
    "slotId": "string",
    "cartItemId": "string",
    "triggeredBy": [
      "string"
    ],
    "ticketName": "string",
    "currency": "EUR",
    "regularPrice": 10.5,
    "realPrice": 10.5,
    "completed": true,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "expiresAt": "2030-01-23T23:00:00.123Z",
    "status": "VALID",
    "secret": "string",
    "barcode": "string",
    "seat": "string",
    "seatingInfo": {
      "_id": "string",
      "_type": 6,
      "categoryId": "string",
      "statusId": "string",
      "name": "string",
      "seatType": "handicapped",
      "sectionName": "string",
      "groupName": "string",
      "rowName": "string",
      "seatName": "string",
      "gate": "string"
    },
    "type": "SINGLE",
    "origin": "yourticket",
    "extraFields": {},
    "batch": "string",
    "batchCounter": 10.5,
    "deliveryType": "HARD",
    "readyForDelivery": true,
    "customMessage": "string",
    "priceCategoryId": "string",
    "entryPermissions": [
      []
    ],
    "customerId": "string",
    "history": [
      []
    ],
    "personalized": true,
    "excludedEventIds": [
      "string"
    ],
    "originTicketId": "string",
    "fulfillmentTypeId": "string",
    "__v": 1
  }
]

Change Ticket's seat

Payload

seatingReservationToken

Required

string

Optional Attributes

Collapse all

seatingInfo

Optional

object

sendMail

Optional

boolean

freeSeat

Optional

boolean

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "seatingInfo": {},
  "seatingReservationToken": "string",
  "sendMail": true,
  "freeSeat": true
}

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Prepare Ticket for delivery

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Send Ticket per mail

Payload

Required

string email

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "email": "[email protected]"
}

Send batch tickets per mail

Payload

Required

string email

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "email": "[email protected]"
}

PUBLIC

Personalize a Ticket

Payload

Optional Attributes

Collapse all

name

Optional

string

The name on the ticket.

firstname

Optional

string

The first name on the ticket.

lastname

Optional

string

The last name on the ticket.

extraFields

Optional

object

Key-value pairs of extra fields for the ticket.

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "extraFields": {}
}

{
  "_id": "string",
  "sellerId": "string",
  "company": "string",
  "email": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "rootEventId": "string",
  "transactionId": "string",
  "posId": "string",
  "underShopId": "string",
  "categoryRef": "string",
  "categoryName": "string",
  "ticketTypeId": "string",
  "slotId": "string",
  "cartItemId": "string",
  "triggeredBy": [
    "string"
  ],
  "ticketName": "string",
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "batch": "string",
  "batchCounter": 10.5,
  "deliveryType": "HARD",
  "readyForDelivery": true,
  "customMessage": "string",
  "priceCategoryId": "string",
  "entryPermissions": [
    []
  ],
  "customerId": "string",
  "history": [
    []
  ],
  "personalized": true,
  "excludedEventIds": [
    "string"
  ],
  "originTicketId": "string",
  "fulfillmentTypeId": "string",
  "__v": 1
}

Get all Tickets

Query

name

Optional

string

Filter tickets by ticket holder name

barcode

Optional

string

Filter tickets by barcode

start

Optional

string date-time

An ISO timestamp to filter tickets created on or after this date

end

Optional

string date-time

An ISO timestamp to filter tickets created on or before this date

status

Optional

string

Filter by a comma(,) separated list of statuses

type

Optional

string

Filter tickets by type

SINGLEMULTI

deliveryType

Optional

string

Filter by a comma(,) separated list of deliverTypes

event

Optional

string

Filter by a comma(,) separated list of event IDs

statusId

Optional

string

Filter tickets with a seat by status ID

gaName

Optional

string

Filter tickets with a seat by general admission name

sectionName

Optional

string

Filter tickets with a seat by section name

groupName

Optional

string

Filter tickets with a seat by group name

rowName

Optional

string

Filter tickets with a seat by row name

seatName

Optional

string

Filter tickets by seat name

customerId

Optional

string

Filter tickets by customer ID

purchaseIntentId

Optional

string

Filter tickets by purchase intent ID

checkoutId

Optional

string

Filter tickets by the ID of the checkout

subscriptionId

Optional

string

Filter tickets by the ID of the subscription

updatedAt

Optional

object

Range of dates indicating when the ticket was last updated in ISO format.

Optional Attributes

Collapse all

updatedAt.$gt

Optional

string date-time

value is greater than

updatedAt.$gte

Optional

string date-time

value is greater than or equal

updatedAt.$lt

Optional

string date-time

value is less than

updatedAt.$lte

Optional

string date-time

value is less than or equal

updatedAt.$eq

Optional

string date-time

value is equal

updatedAt.$ne

Optional

string date-time

value is not equal

batch

Optional

string

Filter tickets by batch

batchCounter

Optional

object

Filter tickets by batch counter

Optional Attributes

Collapse all

batchCounter.$gt

Optional

number float

value is greater than

batchCounter.$gte

Optional

number float

value is greater than or equal

batchCounter.$lt

Optional

number float

value is less than

batchCounter.$lte

Optional

number float

value is less than or equal

batchCounter.$eq

Optional

number float

value is equal

batchCounter.$ne

Optional

number float

value is not equal

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

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "rows": [
    {
      "_id": "string",
      "sellerId": "string",
      "company": "string",
      "email": "string",
      "name": "string",
      "firstname": "string",
      "lastname": "string",
      "street": "string",
      "line2": "string",
      "city": "string",
      "postal": "string",
      "state": "string",
      "country": "string",
      "eventId": "string",
      "rootEventId": "string",
      "transactionId": "string",
      "posId": "string",
      "underShopId": "string",
      "categoryRef": "string",
      "categoryName": "string",
      "ticketTypeId": "string",
      "slotId": "string",
      "cartItemId": "string",
      "triggeredBy": [
        "string"
      ],
      "ticketName": "string",
      "currency": "EUR",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "completed": true,
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "status": "VALID",
      "secret": "string",
      "barcode": "string",
      "seat": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "type": "SINGLE",
      "origin": "yourticket",
      "extraFields": {},
      "batch": "string",
      "batchCounter": 10.5,
      "deliveryType": "HARD",
      "readyForDelivery": true,
      "customMessage": "string",
      "priceCategoryId": "string",
      "entryPermissions": [
        []
      ],
      "customerId": "string",
      "history": [
        []
      ],
      "personalized": true,
      "excludedEventIds": [
        "string"
      ],
      "originTicketId": "string",
      "fulfillmentTypeId": "string",
      "__v": 1
    }
  ],
  "total": 1
}

PUBLIC

Get Tickets of Batch

Query

No supported query parameters

200

400

Bad Request

404

Not Found

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "sellerId": "string",
    "company": "string",
    "email": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "street": "string",
    "line2": "string",
    "city": "string",
    "postal": "string",
    "state": "string",
    "country": "string",
    "eventId": "string",
    "rootEventId": "string",
    "transactionId": "string",
    "posId": "string",
    "underShopId": "string",
    "categoryRef": "string",
    "categoryName": "string",
    "ticketTypeId": "string",
    "slotId": "string",
    "cartItemId": "string",
    "triggeredBy": [
      "string"
    ],
    "ticketName": "string",
    "currency": "EUR",
    "regularPrice": 10.5,
    "realPrice": 10.5,
    "completed": true,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "expiresAt": "2030-01-23T23:00:00.123Z",
    "status": "VALID",
    "secret": "string",
    "barcode": "string",
    "seat": "string",
    "seatingInfo": {
      "_id": "string",
      "_type": 6,
      "categoryId": "string",
      "statusId": "string",
      "name": "string",
      "seatType": "handicapped",
      "sectionName": "string",
      "groupName": "string",
      "rowName": "string",
      "seatName": "string",
      "gate": "string"
    },
    "type": "SINGLE",
    "origin": "yourticket",
    "extraFields": {},
    "batch": "string",
    "batchCounter": 10.5,
    "deliveryType": "HARD",
    "readyForDelivery": true,
    "customMessage": "string",
    "priceCategoryId": "string",
    "entryPermissions": [
      []
    ],
    "customerId": "string",
    "history": [
      []
    ],
    "personalized": true,
    "excludedEventIds": [
      "string"
    ],
    "originTicketId": "string",
    "fulfillmentTypeId": "string",
    "__v": 1
  }
]