iotoms Docs

Get stock on hand for many items

POST
/api/v1/inventory/items/bulk

Returns the stock position (on hand, reserved, available) for every item in itemIds in one call, in the order sent. Items with no stock record come back with zero quantities rather than an error. Read only.

How to use it

  1. Collect the item codes from List items or your own catalog sync.
  2. Send them in itemIds; the response has one row per code, in the same order.
  3. Nothing is changed; use the available quantity to decide what can be sold.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

Request Body

application/json
  1. body
itemIds*array<string>

Item codes (catalog itemId) to look up. Unknown or never-stocked items come back with zero quantities.

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 stock row per requested item ID, in the order sent. Items with no stock record come back with zero quantities.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/inventory/items/bulk' \  -H 'Content-Type: application/json' \  -d '{  "itemIds": [    "string"  ]}'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "itemId": "string",      "itemName": "string",      "quantityOnHand": 0,      "reservedQuantity": 0,      "availableQuantity": 0,      "minimumStockLevel": 0,      "isLowStock": true,      "lastAdjustedAt": "2019-08-24T14:15:22Z",      "lastAdjustedBy": "string",      "version": 0    }  ]}