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

---

SalesReport

Sales report endpoints for summary, charts, sales, transaction, revenue, VAT

Operations

GET/api/v2/report/sales/summaryGET/api/v2/report/sales/chartsGET/api/v2/report/sales/salesGET/api/v2/report/sales/transactionGET/api/v2/report/sales/revenueGET/api/v2/report/sales/vatGET/api/v2/report/sales/export

---

Get sales report summary (KPI cards with prior-period delta and sparkline)

GET

/api/v2/report/sales/summary

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Sales summary data

Content-Type

application/json

"string"

GET

/api/v2/report/sales/summary

Playground

Authorization

bearerAuth

Samples

---

Get per-day sales aggregation for charting (revenue or tickets)

GET

/api/v2/report/sales/charts

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Chart data points

Content-Type

application/json

"string"

GET

/api/v2/report/sales/charts

Playground

Authorization

bearerAuth

Samples

---

Get sales datatable (per-event breakdown with fees; default sort revenue desc)

GET

/api/v2/report/sales/sales

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Sales data

Content-Type

application/json

"string"

GET

/api/v2/report/sales/sales

Playground

Authorization

bearerAuth

Samples

---

Get transaction datatable (per-transaction line items)

GET

/api/v2/report/sales/transaction

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Transaction data

Content-Type

application/json

"string"

GET

/api/v2/report/sales/transaction

Playground

Authorization

bearerAuth

Samples

---

Get revenue datatable (per-event revenue metrics)

GET

/api/v2/report/sales/revenue

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Revenue data

Content-Type

application/json

"string"

GET

/api/v2/report/sales/revenue

Playground

Authorization

bearerAuth

Samples

---

Get VAT datatable (per-transaction VAT breakdown)

GET

/api/v2/report/sales/vat

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

VAT data

Content-Type

application/json

"string"

GET

/api/v2/report/sales/vat

Playground

Authorization

bearerAuth

Samples

---

Export a report type as a downloadable CSV

GET

/api/v2/report/sales/export

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

type*

Which datatable to export.

Type

string

Required

Valid values

"sales""transaction""revenue""vat"

Responses

CSV file download (async=0) or export job record (async=1)

Content-Type

text/csv

GET

/api/v2/report/sales/export

Playground

Authorization

bearerAuth

Variables

Key

Value

type*

Samples

---

Powered by VitePress OpenAPI