iotoms Docs

Get van loading report by vehicle

GET
/api/v1/reports/inventory/van-loading

Returns loaded, sold and returned quantities grouped by day cycle and vehicle for the required from/to date range. The loaded quantity is not currently recorded anywhere, so the computed variance is not reliable; do not show it to end users as a settlement figure.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from*string

ISO date (YYYY-MM-DD)

Formatdate
to*string

ISO 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 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?array<>|

One entry per day cycle that had van stock movements in the date range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/inventory/van-loading?from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "vehicleId": "string",      "dayCycleId": "string",      "loaded": 0,      "sold": 0,      "returned": 0,      "variance": 0    }  ]}