Retrieving Placements
Specific spots within a section (e.g. "B2").
Use GET /api/v1/placements to page through every record in your organization, or GET /api/v1/placements/{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 placement code (like B2) to print shelf and bin labels that match Cloudbox.
Pair placements with SKU data so pick sheets say exactly which shelf to walk to.
Keep your WMS bin list identical to Cloudbox so put-away and picking never disagree.
Compare placements against stock to see open spots before a big receiving day.
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)