iotoms Docs

List inventory locations

GET
/api/v1/inventory/locations

Returns active stock-holding locations, optionally filtered by locationType. Deactivated locations are not listed; fetch one directly with Get an inventory location.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

locationType?string

Only locations of this kind: WAREHOUSE, STORE, VAN, MANUFACTURING, TRANSIT or QUARANTINE.

Value in"WAREHOUSE""STORE""VAN""MANUFACTURING""TRANSIT""QUARANTINE"

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

The stock-holding locations that matched.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/locations'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "locationCode": "string",      "locationName": "string",      "locationType": "WAREHOUSE",      "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",      "storeId": 0,      "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",      "isDefault": true,      "isActive": true    }  ]}