Skip to main content
GET
List Sales
Retrieve paginated sales data linked to bookings. Filter by date range to narrow results.
string
required
Your API key
string
Filter by sale date (start). Format: yyyy-MM-ddTHH:mm:ss.fffZ
string
Filter by sale date (end). Format: yyyy-MM-ddTHH:mm:ss.fffZ
integer
Number of records to return
integer
Zero-based offset for pagination
Response is a paginated result with from, to, length, and items (array of SalesDataReport). SalesDataReport fields saleDetail fields Example 200 Response

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API Key authentication header

Query Parameters

StartDate
string
required

The Sales Transactions Start Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

EndDate
string
required

The Sales Transactions End Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

Limit
integer<int32>

Max number of records to return, default is 100, max is 100.

Required range: 1 <= x <= 100
StartIndex
integer<int32>

Number of matching records to skip before returning the matches, default is 0.

Response

Get paginated sales data with booking summary

from
integer<int64>
to
integer<int64>
length
integer<int64>
items
object[] | null