Pick Orders API

Get access to your pick orders data through Cloudbox's v1 API.

Retrieving Pick Orders

Picking runs, each batching lines from one or more sales orders in route order.

Use GET /api/v1/pick-orders to page through every record in your organization, or GET /api/v1/pick-orders/{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/pick-orders
GET
/api/v1/pick-orders/{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/pick-orders?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
pick_number
string, nullable
Sortable
status
string
Filterable (exact)
location_id
string (uuid), nullable
Location (building/site) ID. Filterable (exact)
assigned_to
string (uuid), nullable
Filterable (exact)
notes
string, nullable
started_at
string (ISO 8601), nullable
completed_at
string (ISO 8601), nullable
Sortable
created_at
string (ISO 8601)
Creation timestamp (UTC). Sortable
updated_at
string (ISO 8601)
Last update timestamp (UTC)
lines
array of objects
Detail endpoint only. Related records: id, sales_order_id, sales_order_line_id, sku_id, placement_id, qty_requested, qty_picked, pick_sequence, picked, picked_at

Filters

limitPage size (default 100, max 1000)
offsetNumber of records to skip (default 0)
sortOne of: pick_number, created_at, completed_at
orderasc | desc
statusopen | in_progress | completed | cancelled
location_idPick orders in this location
assigned_toPick orders assigned to this user
updated_sinceOnly records updated 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)