v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers

https://v2-staging.tscheckout.comCurrent host

---

TicketImports

CSV ticket import: upload file, map columns, preview, and run import (update existing or create new tickets).

Operations

GET/api/v2/ticket-importsPOST/api/v2/ticket-importsGET/api/v2/ticket-imports/mapping-fieldsGET/api/v2/ticket-imports/{id}DELETE/api/v2/ticket-imports/{id}PATCH/api/v2/ticket-imports/{id}GET/api/v2/ticket-imports/{id}/previewPOST/api/v2/ticket-imports/{id}/process

---

List ticket imports

GET

/api/v2/ticket-imports

Returns a list of ticket imports

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Ticket Import list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/ticket-imports

Playground

Authorization

bearerAuth

Samples

---

Create ticket import

POST

/api/v2/ticket-imports

Upload a CSV file and create a draft import.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

multipart/form-data

object

CSV file

Format"binary"

Valid values"update""import""importAndCharge"

Responses

Ticket import created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/ticket-imports

Playground

Authorization

bearerAuth

Body

file*

importType

eventId

ticketTypeId

shippingMethodId

purchaseDateTimestamp

skipFirstRow

readPurchaseDateFromCsv

Samples

---

Get mapping fields

GET

/api/v2/ticket-imports/mapping-fields

Returns column mapping field options for CSV imports

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Mapping field options

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/ticket-imports/mapping-fields

Playground

Authorization

bearerAuth

Samples

---

Get ticket import by ID

GET

/api/v2/ticket-imports/{id}

Returns a single ticket import by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Ticket import object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/ticket-imports/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete ticket import

DELETE

/api/v2/ticket-imports/{id}

Removes the CSV file from storage. If status is not completed (e.g. drafting, processing, failed), the ticket import record is also deleted. If status is completed, only the file is removed and the record is kept (s3Key cleared). Returns 400 if the file could not be removed from storage.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Ticket import and/or file deleted successfully

DELETE

/api/v2/ticket-imports/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update ticket import

PATCH

/api/v2/ticket-imports/{id}

Save column mapping for the import. Allowed only when status is drafting.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Request Body

application/json

"string"

Responses

Ticket import object

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/ticket-imports/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Preview ticket import

GET

/api/v2/ticket-imports/{id}/preview

Returns row count and estimated tickets created/updated without writing

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Preview data

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/ticket-imports/{id}/preview

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Process ticket import

POST

/api/v2/ticket-imports/{id}/process

Runs the CSV import. Import must be in drafting status with column mapping set.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Ticket import object

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/ticket-imports/{id}/process

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---