Retrieving Shipments
Outbound (type sales) and inbound (type purchase) shipments with tracking.
Use GET /api/v1/shipments to page through every record in your organization, or GET /api/v1/shipments/{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
Pull outbound shipments with tracking numbers and email them to the customer automatically.
Filter by type purchase to see what's on the way from vendors and when to expect it.
Look up a shipment by tracking_number when a customer calls asking where their order is.
Use shipment status to update the matching sales order in your other systems.
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)