Retrieving Units of Measure
The organization's unit-of-measure labels for unit-mode and weight-mode items.
Use GET /api/v1/uom-types to page through every record in your organization, or GET /api/v1/uom-types/{id} to fetch a single record. The id is a UUID, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
Show the right unit (each, case, gram, pound) next to every count in your own reports or apps.
Match Cloudbox unit labels to the units your ERP expects so quantities don't get converted wrong.
Filter by mode to handle unit-mode items and weight-mode items differently in a sync.
Use the active list to populate unit pickers in an internal tool so people only pick valid units.
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)