Retrieving Products
Parent catalog items. Each product has one or more SKUs (batches/lots); quantity fields are rollups across its SKUs.
Use GET /api/v1/products to page through every record in your organization, or GET /api/v1/products/{id} to fetch a single record with its related data. The id is a string, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
Pull every product with its category, brand, and price so your ERP or accounting system uses the same catalog Cloudbox counts against.
Read available_units or available_weight per product and push it to Shopify or WooCommerce so customers never order something you don't have.
Compare total stock against safety_stock and lead_time_days to flag products that need to be reordered this week.
Filter by type to pull only finished goods for sales dashboards, or only materials and subassemblies for purchasing.
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)