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

---

Shopping Cart

Manages shopping cart

Operations

GET/api/v2/shopping-cart/active-cartsGET/api/v2/shopping-cart/cart-settingsPOST/api/v2/shopping-cart/previewPOST/api/v2/shopping-cart/createPOST/api/v2/shopping-cart/ticketPUT/api/v2/shopping-cart/ticket/{id}/ticket-pricePUT/api/v2/shopping-cart/ticket/{ticket}/addon-price/{addon}PUT/api/v2/shopping-cart/ticket/{id}/shipping-methodsPUT/api/v2/shopping-cart/ticket/{id}/shippingPOST/api/v2/shopping-cart/ticket/{id}/removePUT/api/v2/shopping-cart/purchaserPUT/api/v2/shopping-cart/ticket/{id}/attendeePUT/api/v2/shopping-cart/ticket/{id}/questionsPUT/api/v2/shopping-cart/ticket/{id}/answersPUT/api/v2/shopping-cart/billingPUT/api/v2/shopping-cart/questionsPUT/api/v2/shopping-cart/answersPUT/api/v2/shopping-cart/addon-price/{addon}PUT/api/v2/shopping-cart/shipping-methodsPUT/api/v2/shopping-cart/promo-codePOST/api/v2/shopping-cart/shippingPOST/api/v2/shopping-cart/remove-ticketsPOST/api/v2/shopping-cart/cancelPUT/api/v2/shopping-cart/detailsPOST/api/v2/shopping-cart/checkoutPOST/api/v2/shopping-cart/manual-checkout

---

List active shopping carts

GET

/api/v2/shopping-cart/active-carts

Returns inventory holds currently in active carts, matching the admin activeCarts monitor (cart ID, IP, events, ticket types, expiry).

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Active carts list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/shopping-cart/active-carts

Playground

Authorization

bearerAuth

Samples

---

Returns the settings for the shopping cart.

GET

/api/v2/shopping-cart/cart-settings

Returns the settings for the shopping cart.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

boxOffice

If set then determin if the box office settings or non box office settings are returned. If not provided then all settings are returned.

Type

boolean

Responses

The list of settings.

Content-Type

application/json

"string"

GET

/api/v2/shopping-cart/cart-settings

Playground

Authorization

bearerAuth

Variables

Key

Value

boxOffice

Samples

---

Adds tickets to the cart.

POST

/api/v2/shopping-cart/preview

Adds tickets to the cart

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"tickets": [

  

],

  

"boxOffice": true

}

Responses

The tickets where added to cart.

Content-Type

application/json

"string"

POST

/api/v2/shopping-cart/preview

Playground

Authorization

bearerAuth

Body

Samples

---

Creates a new shopping cart

POST

/api/v2/shopping-cart/create

Creates a new shopping cart.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"boxOffice": true,

  

"userId": 0,

  

"purchaseLocation": "string",

  

"browser": "string",

  

"remoteAddr": "string"

}

Responses

The new cart.

Content-Type

application/json

{

  

"data": {

  

  

"cart": "string",

  

  

"order": "string",

  

  

"additionalInfo": "string"

  

},

  

"count": 0

}

POST

/api/v2/shopping-cart/create

Playground

Authorization

bearerAuth

Body

Samples

---

Adds tickets to the cart.

POST

/api/v2/shopping-cart/ticket

Adds tickets to the cart

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"tickets": [

  

],

  

"order": "string"

}

Responses

The tickets where added to cart.

Content-Type

application/json

{

  

"data": {

  

  

"cart": "string",

  

  

"order": "string",

  

  

"additionalInfo": {

  

  

  

"attendee": {

  

  

  

  

"ask": true,

  

  

  

  

"required": true,

  

  

  

  

"askForName": true,

  

  

  

  

"askForEmail": true,

  

  

  

  

"askForPhone": true,

  

  

  

  

"askForCompany": true,

  

  

  

  

"askForTitle": true,

  

  

  

  

"askForGender": true,

  

  

  

  

"askForDob": true,

  

  

  

  

"askForAddress": true,

  

  

  

  

"askForEmergencyContact": true,

  

  

  

  

"autoPopulate": true,

  

  

  

  

"enableThirdGenderOption": true,

  

  

  

  

"copyInfoDropdown": true

  

  

  

}

  

  

}

  

},

  

"count": 0

}

POST

/api/v2/shopping-cart/ticket

Playground

Authorization

bearerAuth

Body

Samples

---

Sets the price of a ticket.

PUT

/api/v2/shopping-cart/ticket/{id}/ticket-price

Overrides the price of a ticket. Only support on box office, event change, and upgrade ticket carts.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to set the price for.

Type

string

Required

Request Body

application/json

"string"

Responses

The updated cart.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/ticket/{id}/ticket-price

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Sets the price of an addon.

PUT

/api/v2/shopping-cart/ticket/{ticket}/addon-price/{addon}

Overrides the price of an addon. Only support on box office, event change, and upgrade ticket carts.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

ticket*

ID of ticket to set the price for.

Type

string

Required

addon*

ID of the addon to set the price for.

Type

string

Required

Request Body

application/json

"string"

Responses

The updated cart.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/ticket/{ticket}/addon-price/{addon}

Playground

Authorization

bearerAuth

Variables

Key

Value

ticket*

addon*

Body

Samples

---

Returns the shipping methods available for the indicated tickets.

PUT

/api/v2/shopping-cart/ticket/{id}/shipping-methods

Returns the shippimg methods available for the ticket. If only one shipping method is available then the checkout call will automatically assign it if a shipping method hasn't been indiciated.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to get the shipping methods

Type

string

Required

Request Body

application/json

"string"

Responses

The cart with the answers.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/ticket/{id}/shipping-methods

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Sets the shipping method for the ticket.

PUT

/api/v2/shopping-cart/ticket/{id}/shipping

Sets the shipping method for the ticket. If only one shipping method is available then the checkout call will automatically assign it if a shipping method hasn't been indiciated.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to set the shipping method.

Type

string

Required

Request Body

application/json

{

  

"methodId": "string",

  

"order": "string"

}

Responses

The cart with the answers.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/ticket/{id}/shipping

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Removes the ticket from the cart.

POST

/api/v2/shopping-cart/ticket/{id}/remove

Removes the ticket from the cart.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to remove

Type

integer

Required

Request Body

application/json

"string"

Responses

The update order.

Content-Type

application/json

"string"

POST

/api/v2/shopping-cart/ticket/{id}/remove

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Set the purchaser.

PUT

/api/v2/shopping-cart/purchaser

Sets purchaser for the cart. Replaces existing purchaser if there is one.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"purchaser": {

  

  

"email": "string",

  

  

"name": "string",

  

  

"address": "string",

  

  

"phone": "string"

  

},

  

"order": "string"

}

Responses

The purchaser was set for the cart.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/purchaser

Playground

Authorization

bearerAuth

Body

Samples

---

Set the attendee.

PUT

/api/v2/shopping-cart/ticket/{id}/attendee

Sets attendee for the ticket. Replaces existing attendee if there is one.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to set

Type

string

Required

Request Body

application/json

"string"

Responses

The attendee was set.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/ticket/{id}/attendee

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Returns the questions for tickets

PUT

/api/v2/shopping-cart/ticket/{id}/questions

Get the list of questions for the tickets.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to get the questions for

Type

string

Required

Request Body

application/json

"string"

Responses

The list of question.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/ticket/{id}/questions

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Sets the answer for a ticket

PUT

/api/v2/shopping-cart/ticket/{id}/answers

Sets the answer for a ticket. Replaces any existing answers.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to set the answers for

Type

string

Required

Request Body

application/json

"string"

Responses

The cart with the answers.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/ticket/{id}/answers

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Set the billing info.

PUT

/api/v2/shopping-cart/billing

Sets billing info for the cart. Replaces existing billing if there is one.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"billing": {

  

  

"email": "string",

  

  

"name": "string",

  

  

"address": "string",

  

  

"phone": "string"

  

},

  

"order": "string"

}

Responses

The billing information was set for the cart.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/billing

Playground

Authorization

bearerAuth

Body

Samples

---

Returns the questions for tickets

PUT

/api/v2/shopping-cart/questions

Get the list of questions for the tickets.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to get the questions for

Type

string

Required

Request Body

application/json

"string"

Responses

The list of question.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/questions

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Sets the answer for the order

PUT

/api/v2/shopping-cart/answers

Sets the answer for the order. Replaces any existing answers.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

The cart with the answers.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/answers

Playground

Authorization

bearerAuth

Body

Samples

---

Sets the price of an addon.

PUT

/api/v2/shopping-cart/addon-price/{addon}

Overrides the price of an addon. Only support on box office, event change, and upgrade ticket carts.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

addon*

ID of the addon to set the price for.

Type

string

Required

Request Body

application/json

"string"

Responses

The updated cart.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/addon-price/{addon}

Playground

Authorization

bearerAuth

Variables

Key

Value

addon*

Body

Samples

---

Returns the shipping methods available for all the tickets.

PUT

/api/v2/shopping-cart/shipping-methods

Returns the shippimg methods available for the cart. If only one shipping method is available then the checkout call will automatically assign it if a shipping method hasn't been indiciated.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

The list of shipping methods.

Content-Type

application/json

{

  

"count": 0,

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string",

  

  

  

"description": "string",

  

  

  

"tickets": [

  

  

  

  

"string"

  

  

  

]

  

  

}

  

]

}

PUT

/api/v2/shopping-cart/shipping-methods

Playground

Authorization

bearerAuth

Body

Samples

---

Applies promo codes to the cart.

PUT

/api/v2/shopping-cart/promo-code

Applies all promo codes to the cart. Replaces any promo codes already applied to the cart.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"codes": [

  

  

"string"

  

],

  

"order": "string"

}

Responses

The cart with the answers.

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/promo-code

Playground

Authorization

bearerAuth

Body

Samples

---

Applies shipping method to multiple tickets.

POST

/api/v2/shopping-cart/shipping

Applies shipping method to multiple tickets.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to remove

Type

integer

Required

Request Body

application/json

{

  

"tickets": [

  

  

{

  

  

  

"methodId": "string",

  

  

  

"ticketId": "string"

  

  

}

  

],

  

"order": "string"

}

Responses

The updated order.

Content-Type

application/json

"string"

POST

/api/v2/shopping-cart/shipping

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Removes tickets from the cart.

POST

/api/v2/shopping-cart/remove-tickets

Removes tickets from the cart.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of ticket to remove

Type

integer

Required

Request Body

application/json

{

  

"tickets": [

  

],

  

"order": "string"

}

Responses

The updated order.

Content-Type

application/json

"string"

POST

/api/v2/shopping-cart/remove-tickets

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Cancels the cart.

POST

/api/v2/shopping-cart/cancel

Cancels the cart.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

The order was canceled successfully.

POST

/api/v2/shopping-cart/cancel

Playground

Authorization

bearerAuth

Body

Samples

---

Returns the cart's details.

PUT

/api/v2/shopping-cart/details

Returns the cart's details.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"order": "string"

}

Responses

The cart detials

Content-Type

application/json

"string"

PUT

/api/v2/shopping-cart/details

Playground

Authorization

bearerAuth

Body

Samples

---

Starts the checkout process.

POST

/api/v2/shopping-cart/checkout

Starts the checkout process returning information needed to process payment. This call can only be made once per order.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

result

Determines the format of repsonse. If not provided the default is id. Can be one of the following values:

• none - no body is returned.
• id - The id of the customer is returend.
• object - The entire object is returned.

Type

string

Request Body

application/json

{

  

"method": "credit",

  

"device": "string",

  

"order": "string"

}

Responses

The updated order.

Content-Type

application/json

"string"

POST

/api/v2/shopping-cart/checkout

Playground

Authorization

bearerAuth

Variables

Key

Value

result

Body

Samples

---

Starts the checkout process for a manually entered card.

POST

/api/v2/shopping-cart/manual-checkout

Starts the checkout process for a manually keyed card, returning the information needed to confirm the payment with the standard Stripe payment sheet (mobile SDK) or Payment Element (web). The PaymentIntent created here only accepts the card payment method, so it can not be sent to a Stripe Terminal reader; use /checkout with method tapToPay or terminal for card-present payments. This call can only be made once per order.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"order": "string"

}

Responses

The updated order.

Content-Type

application/json

"string"

POST

/api/v2/shopping-cart/manual-checkout

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI