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

---

Reports

Endpoints to interact with reports

Operations

POST/api/v2/report/sales-by-eventPOST/api/v2/report/sales-by-ticket-typePOST/api/v2/report/sales-by-datePOST/api/v2/report/sales-by-eventsPOST/api/v2/report/ranking-promo-code-usesPOST/api/v2/report/merchandisePOST/api/v2/report/refund-protectPOST/api/v2/report/sales-by-affiliatePOST/api/v2/report/sales-by-regionPOST/api/v2/report/merchandise-summaryPOST/api/v2/report/refund-protect-summaryGET/api/v2/report/reconciliation-by-ticket

---

Generate a sales by event report

POST

/api/v2/report/sales-by-event

Generate a sales by event report

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"fromYear": 0,

  

"fromMonth": 0,

  

"fromDay": 0,

  

"fromHour": 0,

  

"fromMinute": 0,

  

"fromSecond": 0,

  

"toYear": 0,

  

"toMonth": 0,

  

"toDay": 0,

  

"toHour": 23,

  

"toMinute": 59,

  

"toSecond": 59,

  

"useUtc": false,

  

"utcOffset": 0,

  

"eventIds": [

  

  

0

  

],

  

"_limit": 0,

  

"_offset": 0,

  

"includeTypeData": true,

  

"paymentMethod": "credit",

  

"soldByAdmin": 0,

  

"importedStatus": "notImported",

  

"codeGroup": "",

  

"eventManager": [

  

  

0

  

],

  

"categories": [

  

  

0

  

],

  

"insuranceStatus": "",

  

"purchaseLocation": ""

}

Responses

Sales by event report (data keyed by event id)

Content-Type

application/json

"string"

POST

/api/v2/report/sales-by-event

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a sales by ticket type report

POST

/api/v2/report/sales-by-ticket-type

Generate a sales by ticket type report

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"fromYear": 0,

  

"fromMonth": 0,

  

"fromDay": 0,

  

"fromHour": 0,

  

"fromMinute": 0,

  

"fromSecond": 0,

  

"toYear": 0,

  

"toMonth": 0,

  

"toDay": 0,

  

"toHour": 23,

  

"toMinute": 59,

  

"toSecond": 59,

  

"useUtc": false,

  

"utcOffset": 0,

  

"eventIds": [

  

  

0

  

],

  

"typeIds": [

  

  

0

  

],

  

"_limit": 0,

  

"_offset": 0,

  

"transferStatus": ""

}

Responses

Sales by ticket type report (data keyed by event id)

Content-Type

application/json

"string"

POST

/api/v2/report/sales-by-ticket-type

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a sales by date report

POST

/api/v2/report/sales-by-date

Generate a sales by date report

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"fromYear": 0,

  

"fromMonth": 0,

  

"fromDay": 0,

  

"fromHour": 0,

  

"fromMinute": 0,

  

"fromSecond": 0,

  

"toYear": 0,

  

"toMonth": 0,

  

"toDay": 0,

  

"toHour": 23,

  

"toMinute": 59,

  

"toSecond": 59,

  

"useUtc": false,

  

"utcOffset": 0,

  

"eventIds": [

  

  

0

  

]

}

Responses

Sales by date report (data keyed by Y-m-d date)

Content-Type

application/json

"string"

POST

/api/v2/report/sales-by-date

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a sales by events report

POST

/api/v2/report/sales-by-events

Generate a sales by events report

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Sales by events report (paged date buckets, data keyed by Y-m-d date)

Content-Type

application/json

"string"

POST

/api/v2/report/sales-by-events

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a promo code usage ranking report

POST

/api/v2/report/ranking-promo-code-uses

Generate a promo code usage ranking report

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Promo code usage ranking

Content-Type

application/json

"string"

POST

/api/v2/report/ranking-promo-code-uses

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a merchandise report

POST

/api/v2/report/merchandise

Generate a merchandise report

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"fromYear": 0,

  

"fromMonth": 0,

  

"fromDay": 0,

  

"fromHour": 0,

  

"fromMinute": 0,

  

"fromSecond": 0,

  

"toYear": 0,

  

"toMonth": 0,

  

"toDay": 0,

  

"toHour": 23,

  

"toMinute": 59,

  

"toSecond": 59,

  

"useUtc": false,

  

"utcOffset": 0,

  

"eventIds": [

  

  

0

  

],

  

"_limit": 0,

  

"_offset": 0,

  

"codeGroup": "",

  

"categories": [

  

  

0

  

]

}

Responses

Merchandise (add-on answers) report

Content-Type

application/json

"string"

POST

/api/v2/report/merchandise

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a Refund Protect report

POST

/api/v2/report/refund-protect

Generate a Refund Protect report

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Refund Protect (purchase protection) report

Content-Type

application/json

"string"

POST

/api/v2/report/refund-protect

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a sales by affiliate report

POST

/api/v2/report/sales-by-affiliate

Sales aggregated by affiliate (promoterParent): orders, tickets sold and revenue.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Sales by affiliate report

Content-Type

application/json

"string"

POST

/api/v2/report/sales-by-affiliate

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a sales by region report

POST

/api/v2/report/sales-by-region

Sales aggregated by a geographic dimension (state, country, zip or city).

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Sales by region report

Content-Type

application/json

"string"

POST

/api/v2/report/sales-by-region

Playground

Authorization

bearerAuth

Body

Samples

---

Merchandise sales summary for the dashboard Operations tab

POST

/api/v2/report/merchandise-summary

Rolled-up add-on sales: item count, orders, revenue, and a daily sparkline.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"fromYear": 0,

  

"fromMonth": 0,

  

"fromDay": 0,

  

"fromHour": 0,

  

"fromMinute": 0,

  

"fromSecond": 0,

  

"toYear": 0,

  

"toMonth": 0,

  

"toDay": 0,

  

"toHour": 23,

  

"toMinute": 59,

  

"toSecond": 59,

  

"useUtc": false,

  

"utcOffset": 0,

  

"eventIds": [

  

  

0

  

],

  

"codeGroup": "",

  

"categories": [

  

  

0

  

]

}

Responses

Merchandise summary

Content-Type

application/json

"string"

POST

/api/v2/report/merchandise-summary

Playground

Authorization

bearerAuth

Body

Samples

---

Refund Protect summary for the dashboard Operations tab

POST

/api/v2/report/refund-protect-summary

Rolled-up purchase-protection stats: tickets, orders, protected amount, premium, and a daily sparkline.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Refund Protect summary

Content-Type

application/json

"string"

POST

/api/v2/report/refund-protect-summary

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a reconciliation by ticket report

GET

/api/v2/report/reconciliation-by-ticket

Generate a reconciliation by ticket report. Offset and limit paginate by transaction; each returned transaction includes all of its line items. Missing line items are created before results are returned. When outputFormat=csv, data is a CSV string (one row per line item) while limit, offset, and totalCount remain unchanged.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

fromYear

Type

integer

Default

"2026"

fromMonth

Type

integer

Default

"8"

fromDay

Type

integer

Default

"24"

fromHour

Type

integer

Default

0

fromMinute

Type

integer

Default

0

fromSecond

Type

integer

Default

0

toYear

Type

integer

Default

"2026"

toMonth

Type

integer

Default

"8"

toDay

Type

integer

Default

"24"

toHour

Type

integer

Default

23

toMinute

Type

integer

Default

59

toSecond

Type

integer

Default

59

useUtc

Type

boolean

Default

false

eventFilter

Event IDs to include (comma-separated)

Type

string

types

Transaction types to include (comma-separated), e.g. order,attendeeAddOns,upgradeTickets,ticketRefund

Type

string

paymentMethods

Payment methods to include (comma-separated), e.g. credit,cash,sezzle

Type

string

limit

Max number of transactions to return

Type

integer

Default

500

offset

Number of transactions to skip

Type

integer

Default

0

outputFormat

Response data format. json returns nested transaction objects; csv puts a CSV string (header + rows) in data.

Type

string

Valid values

"json""csv"

Default

"json"

Responses

GET

/api/v2/report/reconciliation-by-ticket

Playground

Authorization

bearerAuth

Variables

Key

Value

fromYear

fromMonth

fromDay

fromHour

fromMinute

fromSecond

toYear

toMonth

toDay

toHour

toMinute

toSecond

useUtc

eventFilter

types

paymentMethods

limit

offset

outputFormat

Samples

---

Powered by VitePress OpenAPI