iotoms Docs

List stock on hand

GET
/api/v1/inventory/items

Returns items with their quantity on hand, most recently adjusted first, paginated with 0-based page and size (default 20). Filter with lowStock, a from/to last-adjusted date range, or query (item name, item ID or UPC).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

lowStock?boolean

Set true to return only items with a reorder point whose stock on hand is at or below it.

from?string

ISO date (YYYY-MM-DD)

Formatdate
to?string

ISO date (YYYY-MM-DD)

Formatdate
query?string

Text search on item name, item ID, UPC

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

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?

One page of item stock rows, most recently adjusted first: content holds the entries and page holds size, number (0-based), totalElements and totalPages.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/items'
Example Response
{  "status": "string",  "message": "string",  "data": {    "totalElements": 0,    "totalPages": 0,    "first": true,    "last": true,    "size": 0,    "content": [      {        "transactionId": "string",        "cartId": "string",        "businessDate": "2019-08-24",        "grandTotal": 0,        "paymentStatus": "string",        "channel": "string",        "createdAt": "string"      }    ],    "number": 0,    "sort": [      {        "direction": "string",        "nullHandling": "string",        "ascending": true,        "property": "string",        "ignoreCase": true      }    ],    "numberOfElements": 0,    "pageable": {      "offset": 0,      "sort": [        {          "direction": "string",          "nullHandling": "string",          "ascending": true,          "property": "string",          "ignoreCase": true        }      ],      "paged": true,      "pageNumber": 0,      "pageSize": 0,      "unpaged": true    },    "empty": true  }}