iotoms Docs

List slow-moving items

GET
/api/v1/reports/sales/slow-items

Returns items whose quantity sold in the range is strictly below minQtySold (default 1), lowest first. Only items that sold at least once in the range (voided sales excluded) are listed; items with no sales at all do not appear. from and to are dates (YYYY-MM-DD) and both default to today.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

Start date, YYYY-MM-DD.

Formatdate
to?string

End date, YYYY-MM-DD.

Formatdate
minQtySold?number

Items with qty sold strictly below this threshold

Default1

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 it worked, ERROR when it failed.

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?array<>|

Slow-moving items, lowest quantity sold first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/sales/slow-items' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "itemId": "string",      "itemName": "string",      "categoryName": "string",      "qtySold": 0,      "totalRevenue": 0    }  ]}