iotoms Docs

List stock at a location

GET
/api/v1/inventory/locations/{id}/items

Returns every item held at the location with its quantity on hand, minimum stock level and a low-stock flag. Reservations are tracked per item, not per location, so reserved quantity here is always 0.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?array<>|

Each item held at the location with its quantities.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/locations/497f6eca-6276-4993-bfeb-53cbbbba6f08/items'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "itemId": "string",      "itemName": "string",      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",      "locationName": "string",      "quantityOnHand": 0,      "reservedQuantity": 0,      "availableQuantity": 0,      "minimumStockLevel": 0,      "isLowStock": true,      "lastAdjustedAt": "2019-08-24T14:15:22Z",      "version": 0    }  ]}