Get sales by category
GET
Returns revenue per catalog category. Paginated with 0-based page and size (default 20). from and to are dates (YYYY-MM-DD) and both default to today.
BearerAuthheader
AuthorizationBearer <JWT>from?stringStart date, YYYY-MM-DD.
Format
dateto?stringEnd date, YYYY-MM-DD.
Format
datepage?integerPage number, starting at 0. See Paging.
Format
int32Default
0size?integerNumber of records per page.
Format
int32Default
20X-TenantID*stringYour merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.
OK
*/*- response
status*stringOutcome of the call: SUCCESS when it worked, ERROR when it failed.
message*stringShort human-readable message describing the outcome, for example "Vendor created". Do not parse it.
data?One page of per-category sales rows with paging totals.
Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/sales/by-category' \ -H 'X-TenantID: your-tenant-code'Example Response
{ "status": "string", "message": "string", "data": { "totalElements": 0, "totalPages": 0, "first": true, "last": true, "size": 0, "content": [ { "transactionId": "string", "cartId": "string", "businessDate": "2019-08-24", "grandTotal": 0, "paymentStatus": "string", "channel": "string", "createdAt": "string" } ], "number": 0, "sort": [ { "direction": "string", "nullHandling": "string", "ascending": true, "property": "string", "ignoreCase": true } ], "numberOfElements": 0, "pageable": { "offset": 0, "sort": [ { "direction": "string", "nullHandling": "string", "ascending": true, "property": "string", "ignoreCase": true } ], "paged": true, "pageNumber": 0, "pageSize": 0, "unpaged": true }, "empty": true }}