iotoms Docs

Get stock currently on vans

GET
/api/v1/reports/inventory/balance-in-transit

Returns the stock held in each active van location, item by item, with the open day cycle for that van when there is one.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

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 active van stock location with the items it holds.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/inventory/balance-in-transit' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",      "locationName": "string",      "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",      "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1",      "items": [        {          "itemId": "string",          "itemName": "string",          "quantityOnHand": 0        }      ]    }  ]}