Skip to content

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

Submit attendee information for a box-office order​

POST
/api/v2/box-office/attendees

Submits attendee info, question answers, waiver signatures, and team assignments for a box-office order. Data is validated and stored temporarily on the cart for finalization.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Validated attendee data echoed back

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


View the active box office cart​

GET
/api/v2/box-office/cart

Returns the authenticated admin's active cart with all items and prices. 404 if no active cart.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

Active cart

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization

Samples​


Add an item to the box office cart​

POST
/api/v2/box-office/cart

Adds a ticket type to the admin's active cart. Auto-creates a cart if none exists.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Item added, full cart returned

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Remove an item from the cart​

DELETE
/api/v2/box-office/cart/{itemId}

Removes a specific item from the admin's active cart.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

itemId*
Type
integer
Required

Responses​

Item removed, full cart returned

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​


Update quantity of a cart item​

PATCH
/api/v2/box-office/cart/{itemId}

Updates the quantity, wave time, and/or shipping method of a specific cart line. waveTimeId applies to the targeted line only. At least one of quantity or waveTimeId is required.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

itemId*
Type
integer
Required

Request Body​

application/json
JSON
"string"

Responses​

Item updated, full cart returned

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get checkout questions for a box-office order​

GET
/api/v2/box-office/checkout-questions/{guid}

Returns party member field flags, per-ticket custom questions, waivers, team config, and purchaser-level event questions for the given order.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

Order GUID

Type
string
Required
Format
"uuid"

Responses​

Checkout questions payload

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​


Check in tickets on a box-office order​

POST
/api/v2/box-office/orders/{orderId}/check-in

Check in one or all eligible tickets on a finalized box-office order. Returns HTTP 200 with per-ticket success/failure results (partial success allowed). Requires the order to be linked to a box-office cart for the authenticated admin.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

orderId*

Order id returned from checkout finalization

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
"string"

Responses​

Check-in completed; inspect results for per-ticket outcomes

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Create an order from the active cart​

POST
/api/v2/box-office/orders

Creates an order from the admin's active cart. Marks the cart as "placed" and refreshes inventory hold timers. Does not start a payment — use POST /box-office/checkout after this.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

Order created.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization

Samples​


Get order summary by order GUID​

GET
/api/v2/box-office/order-summary/{guid}

Rebuilds pricing from the cart linked to the given order GUID. Calculates all fees using box-office backend rates and returns line items + totals.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

Order GUID returned from POST /box-office/orders

Type
string
Required
Format
"uuid"

Responses​

Order summary with line items and totals

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​


Get reprint artifacts for an order​

GET
/api/v2/box-office/orders/{orderId}/print-artifacts

Regenerates the Boca/thermal print artifact URLs (and order hash) for an already-finalized box-office order so operators can reprint tickets without placing a new order.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

orderId*

Order id returned from checkout finalization

Type
integer
Required

Responses​

Print artifact URLs for the order

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​


Apply a promo code to the cart or order​

POST
/api/v2/box-office/promo-code

Validates the promo code, optimizes assignment against other promos on the cart, and persists per line item. Send guid (order GUID) when the cart is linked to an order; omit guid to use the authenticated admin’s active cart. Returns 200 on success so the client can refetch cart or order summary.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Promo code applied

application/json
JSON
{
  
"data": [
  
]
}

Playground​

Authorization
Body

Samples​


Remove a promo code from the active cart​

DELETE
/api/v2/box-office/promo-code

Uses the authenticated admin’s active cart (no order GUID).

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

promoCode*

Promo code string to remove

Type
string
Required

Responses​

Promo code removed

application/json
JSON
{
  
"data": [
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​


Remove a promo code from an order-linked cart​

DELETE
/api/v2/box-office/promo-code/{guid}

Removes the specified promo code from applicable ticket holds for the cart linked to the order guid.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

guid*

Order GUID

Type
string
Required
Format
"uuid"

Query Parameters

promoCode*

Promo code string to remove

Type
string
Required

Responses​

Promo code removed

application/json
JSON
{
  
"data": [
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​


Set purchaser for a box-office order​

POST
/api/v2/box-office/purchaser

Sets the purchaser for a box-office order. Use type "boxOffice" for the generic box-office user or "customer" to find/create a real customer by email.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Purchaser set successfully

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Start payment for a box-office order​

POST
/api/v2/box-office/checkout

Starts the payment process for an existing box-office order. The operator selects credit or cash on the checkout page. For credit, creates a Stripe PaymentIntent and returns the client_secret. For cash, marks the order ready for immediate verification.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"guid": "string",
  
"method": "credit",
  
"device": "string",
  
"paymentToken": "string",
  
"verificationToken": "string",
  
"trackData": "string",
  
"isPresent": true,
  
"cardNumber": "string",
  
"cardExpirationMonth": 0,
  
"cardExpirationYear": 0,
  
"cardCode": "string",
  
"digitzsTokenId": "string",
  
"digitzsCustomerId": "string",
  
"threeDsCavv": "string",
  
"threeDsXid": "string",
  
"threeDsDirectoryServerId": "string",
  
"threeDsEci": "string",
  
"threeDsCardHolderAuth": "string",
  
"threeDsThreeDsVersion": "string"
}

Responses​

Checkout started successfully.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Verify payment and finalize box-office order​

POST
/api/v2/box-office/verify-payment

Verifies the payment status for a box-office order. If the payment has succeeded, finalizes the order (creates tickets, transaction, updates inventory). For cash/zero-dollar orders, finalizes immediately. The client should poll this endpoint after checkout.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"guid": "string"
}

Responses​

Order finalized successfully.

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Cancel box-office payment​

POST
/api/v2/box-office/cancel-payment

Cancels the Stripe PaymentIntent (if any) and resets the cart status to "placed" so the operator can modify the cart or retry checkout.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"guid": "string"
}

Responses​

Payment cancelled, cart reset.

Playground​

Authorization
Body

Samples​


Powered by VitePress OpenAPI