iotoms Docs

Get stock take count sheet

GET
/api/v1/reports/inventory/stock-take

Returns the current system quantity on hand per item and stock location, for use as a physical count sheet. Pass locationId to limit it to one location.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

locationId?string

Filter by location UUID (optional)

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 row per item per stock location, sorted by item ID.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/inventory/stock-take' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "itemId": "string",      "itemName": "string",      "sku": "string",      "locationId": "string",      "systemQoh": 0,      "note": "string",      "locationName": "string"    }  ]}