iotoms Docs

List dead stock

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

Returns items with no sale for at least minDaysSinceLastSale days (default 90), longest-idle first. Items that have never sold are included with daysSinceLastSale set to -1.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

minDaysSinceLastSale?integer

Minimum days without a sale (default 90)

Formatint32
Default90

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<>|

Items that have not sold for at least the requested number of days, longest idle first; items that have never sold (daysSinceLastSale -1) come last.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/inventory/dead-stock' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "itemId": "string",      "itemName": "string",      "quantityOnHand": 0,      "lastSaleDate": "2019-08-24",      "daysSinceLastSale": 0    }  ]}