iotoms Docs

Get revenue by sales channel

GET
/api/v1/reports/financial/revenue-by-channel

Returns revenue for a date range split by channel: point of sale (POS), van/route distribution (LINE_DISTRIBUTION) and online (ECOM). from and to default to today.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

ISO date (YYYY-MM-DD), defaults to today

Formatdate
to?string

ISO date (YYYY-MM-DD), defaults to today

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 the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

Total revenue for the range and its split by sales channel.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/financial/revenue-by-channel' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "from": "2019-08-24",    "to": "2019-08-24",    "totalRevenue": 0,    "channels": [      {        "channelCode": "string",        "channelLabel": "string",        "totalRevenue": 0,        "transactionCount": 0,        "percentageOfTotal": 0.1      }    ]  }}