Retrieving Locations
Buildings / sites. Each location contains sections.
Use GET /api/v1/locations to page through every record in your organization, or GET /api/v1/locations/{id} to fetch a single record with its related data. The id is a UUID, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
Pull every building or site so your WMS or ERP uses the same location names Cloudbox does.
Group SKU and container counts by location to see how much inventory sits in each warehouse.
Use location data to send each order to the building that actually has the stock.
Fill location dropdowns in internal tools with the active list so nobody types a site by hand.
Required Headers
Every request must include the following:
Requests missing either header will return 401 Unauthorized
Example Request
Response Schema
Filters
Errors
Cloudbox uses standard HTTP status codes to indicate API success or failure:
- 200–299 – Request succeeded
- 400 – Bad request (missing parameters, invalid values)
- 401 – Unauthorized (missing or invalid API keys)
- 404 – Resource not found
- 429 – Too many requests (rate limited)