iotoms Docs

Get stock on hand for an item

GET
/api/v1/inventory/items/{itemId}

Returns the current company-wide stock position for one item: on hand, reserved and available quantities and its reorder point. An item that has never been stocked returns zero quantities.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

itemId*string

Item code (the catalog itemId), from List items.

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?

The item's company-wide stock position: on hand, reserved and available quantities.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/items/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  }}