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

---

TicketRules

Polymorphic ticket rules: sales rules, dated price changes, quantity price changes

Operations

GET/api/v2/events/{eventId}/ticket-rulesGET/api/v2/events/{eventId}/ticket-rules/{type}/{id}DELETE/api/v2/events/{eventId}/ticket-rules/{type}/{id}PATCH/api/v2/events/{eventId}/ticket-rules/{type}/{id}POST/api/v2/events/{eventId}/ticket-rules/{type}POST/api/v2/events/{eventId}/ticket-rules/bulk-delete

---

Get ticket rules

GET

/api/v2/events/{eventId}/ticket-rules

Returns a list of ticket rules for an event

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

Responses

Ticket rule list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/events/{eventId}/ticket-rules

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Samples

---

Get ticket rule by type and ID

GET

/api/v2/events/{eventId}/ticket-rules/{type}/{id}

Returns a single ticket rule by type and id

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

type*

Rule type: sales-rule, dated-price-change, quantity-price-change

Type

string

Required

Valid values

"sales-rule""dated-price-change""quantity-price-change"

id*

Rule Id

Type

integer

Required

Format

"int64"

Responses

Ticket rule object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/events/{eventId}/ticket-rules/{type}/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

type*

id*

Samples

---

Delete ticket rule

DELETE

/api/v2/events/{eventId}/ticket-rules/{type}/{id}

Delete a ticket rule

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

type*

Rule type

Type

string

Required

Valid values

"sales-rule""dated-price-change""quantity-price-change"

id*

Rule Id

Type

integer

Required

Format

"int64"

Responses

Ticket rule deleted successfully

DELETE

/api/v2/events/{eventId}/ticket-rules/{type}/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

type*

id*

Samples

---

Update ticket rule

PATCH

/api/v2/events/{eventId}/ticket-rules/{type}/{id}

Update an existing ticket rule

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

type*

Rule type: sales-rule, dated-price-change, quantity-price-change

Type

string

Required

Valid values

"sales-rule""dated-price-change""quantity-price-change"

id*

Rule Id

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated ticket rule

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/events/{eventId}/ticket-rules/{type}/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

type*

id*

Body

Samples

---

Create ticket rule

POST

/api/v2/events/{eventId}/ticket-rules/{type}

Create a ticket rule (sales-rule, dated-price-change, or quantity-price-change)

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

type*

Rule type: sales-rule, dated-price-change, quantity-price-change

Type

string

Required

Valid values

"sales-rule""dated-price-change""quantity-price-change"

Request Body

application/json

"string"

Responses

Created ticket rule

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/events/{eventId}/ticket-rules/{type}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

type*

Body

Samples

---

Bulk delete ticket rules

POST

/api/v2/events/{eventId}/ticket-rules/bulk-delete

Delete multiple ticket rules

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

Request Body

application/json

{

  

"rules": [

  

  

{

  

  

  

"type": "string",

  

  

  

"id": 0

  

  

}

  

]

}

Responses

Ticket rules deleted successfully

POST

/api/v2/events/{eventId}/ticket-rules/bulk-delete

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Body

Samples

---

Powered by VitePress OpenAPI