v1
latestOpenAPI 3.0.02026-07-2673188210.8 KBhost
Get sales
Note: This is an experimental feature, please contact support if you want to utilize this endpoint.
This endpoint returns a list of host sales. The default sorting mode is DESC (newest sales first), but you can also specify ASC (oldest sales first). For session and appointment sales, additional meta data is returned in the response.
get/api/v2/host/sales
Query parameters
pageinteger required
Starts at 0
pageSizeinteger required
Example:10
sortOrder'ASC' | 'DESC'
sortBystring
Field to sort by
Response
Example response
{
"pagination": {
"pageSize": 10,
"totalCount": 1
},
"payload": [
{
"id": 1,
"saleDate": "2021-01-01T00:00:00Z",
"items": [
{
"id": 1,
"saleItemId": 1,
"itemType": "membership",
"itemName": "Monthly Membership for Johns",
"descriptiveItemName": "Monthly Membership for Johns",
"payingMember": {
"id": 1,
"firstName": "John",
"lastName": "Doe"
},
"targetMember": {
"id": 1,
"firstName": "John",
"lastName": "Doe"
},
"session": {
"id": 1,
"name": "Monday Morning Yoga",
"startsAt": "2021-01-01T00:00:00Z",
"endsAt": "2021-01-01T01:00:00Z"
},
"appointment": {
"id": 3,
"name": "Stretching with John"
},
"product": {
"id": 3,
"name": "T-Shirt"
},
"productVariant": {
"id": 3,
"name": "M"
},
"openArea": {
"id": 3,
"name": "Gym A"
},
"quantity": 1,
"unitPriceExcludingTaxInCurrency": "9.99",
"unitTaxAmountInCurrency": "0.43"
}
],
"paymentTransaction": {
"items": [
{
"paymentMethodType": "custom",
"paymentMethodName": "Custom payment method",
"amountInCurrencyWithoutTax": "9.99",
"taxAmountInCurrency": "9.99"
}
]
}
}
]
}