Retrieving Sales Orders
Sales orders with lines and shipments.
Use GET /api/v1/sales-orders to page through every record in your organization, or GET /api/v1/sales-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
Current Use Cases
Send sales orders with their lines to QuickBooks or your ERP so revenue and inventory match.
Pull orders by status to show what's open, picking, shipped, and complete.
Filter by external_reference to find the Cloudbox order behind a Shopify, Amazon, or WooCommerce order.
Use date_from and date_to to pull one day or week of orders for a sales report.
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)