iotoms Docs

Get van inventory report by day cycle

GET
/api/v1/reports/inventory/van

Returns loaded, sold and returned quantities per van day cycle. Optionally filter by from/to dates or a single dayCycleId. 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
dayCycleId?string

Filter by a specific day cycle UUID

Formatuuid

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 van day cycle in the requested range, each with its item breakdown.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/inventory/van' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1",      "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",      "businessDate": "2019-08-24",      "items": [        {          "itemId": "string",          "itemName": "string",          "loadedQty": 0,          "soldQty": 0,          "returnedQty": 0,          "varianceQty": 0,          "unitCost": 0,          "varianceValue": 0        }      ],      "totalLoadedValue": 0,      "totalSoldValue": 0,      "varianceValue": 0,      "vehicleLabel": "string"    }  ]}