Container Removals API

Get access to your container removals data through Cloudbox's v1 API.

Retrieving Container Removals

Scan-outs from mixed containers: what was removed, the expected vs. measured weight drop, and the variance.

Use GET /api/v1/container-removals to page through every record in your organization, or GET /api/v1/container-removals/{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

GET
/api/v1/container-removals
GET
/api/v1/container-removals/{id}

Required Headers

Every request must include the following:

Header Key
Description
org-api-key
Your Organization API key. Contact Cloudbox Support For Access: support@cloudboxapp.com.
user-api-key
Your User API Key

Requests missing either header will return 401 Unauthorized

Example Request

bash curl -X GET "https://app.cloudboxapp.com/api/v1/container-removals?limit=100" \ -H "org-api-key: YOUR_ORG_API_KEY" \ -H "user-api-key: YOUR_USER_API_KEY" \ -H "Accept: application/json"

Response Schema

Column
Type
Description
id
string (uuid)
Unique ID
container_id
string
References Containers. Filterable (exact)
user_id
string (uuid), nullable
References Account. Filterable (exact)
status
string
Filterable (exact)
weight_before
number, nullable
weight_after
number, nullable
expected_drop
number, nullable
variance
number, nullable
override
boolean
report_id
string, nullable
References Reports
confirmed_at
string (ISO 8601), nullable
created_at
string (ISO 8601)
Creation timestamp (UTC). Sortable
lines
array of objects
Detail endpoint only. Related records: sku_id, units, unit_weight

Filters

limitPage size (default 100, max 1000)
offsetNumber of records to skip (default 0)
sortOne of: created_at
orderasc | desc
container_idRemovals from this container
statusRemoval status
user_idRemovals by this user
created_sinceOnly records created at or after this ISO 8601 timestamp
default sortcreated_at descending

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)