iotoms Docs

Get sales by route

GET
/api/v1/reports/sales/by-route

Returns revenue per van-sales route plan for the date range. Only sales made during a day cycle that ran on a route plan are counted; voided sales are excluded. from and to are dates (YYYY-MM-DD) and both default to today.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

Start date, YYYY-MM-DD.

Formatdate
to?string

End date, YYYY-MM-DD.

Formatdate

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when it worked, ERROR when it failed.

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?array<>|

One row per route plan that had sales in the range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/sales/by-route' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "routePlanId": "string",      "routePlanCode": "string",      "routePlanName": "string",      "totalRevenue": 0,      "transactionCount": 0,      "storesVisited": 0    }  ]}