Orders
The Order object represents a commercial transaction. It tracks everything from initial placement to final fulfillment and financial settlement.
The Order Object
A detailed breakdown of all fields available in the Order resource.
Identity & Metadata
| Field | Type | Description |
|---|---|---|
idRequired | string | Unique identifier for the order. Prefixed with 'ord_'. Example: ord_01JGK9 |
numberRequired | string | The human-readable order number shown to customers. Example: BS-10024 |
external_id | string | The ID from your source system (ERP, Shopify, etc). Example: 9928120 |
created_at | datetime | ISO 8601 timestamp of when the order was created. |
Financials
| Field | Type | Description |
|---|---|---|
currencyRequired | string | Three-letter ISO currency code. Example: USD |
total_amountRequired | decimal | Total value of the order including taxes and shipping. Example: 245.00 |
tax_amount | decimal | Total taxes applied. |
payment_status | enum | Current financial state: 'authorized', 'captured', 'refunded', 'voided'. Example: captured |
Fulfillment
| Field | Type | Description |
|---|---|---|
statusRequired | enum | Current workflow state: 'pending', 'processing', 'shipped', 'delivered', 'cancelled'. Example: processing |
shipping_method | string | The carrier service selected. Example: fedex_ground |
tracking_number | string | Live tracking identifier from the carrier. |
List Orders
GET /v1/ordersRetrieve a list of orders. Use query parameters to filter by status or date range. Results are paginated by default.
Filter Parameters
| Field | Type | Description |
|---|---|---|
status | string | Filter by status code (e.g., 'processing') |
customer_id | string | Filter orders for a specific customer. |
limit | integer | Results per page. Max 100. Example: 50 |
offset | integer | Number of records to skip. |
Create Order
POST /v1/ordersCreate a new order. This will trigger the default workflow, including stock allocation and ERP synchronization.
Side Effects
Creating an order via API automatically reserves inventory in the Inventory Cloud. If stock is unavailable, the request will return a 422 Unprocessable Entity error.
Common Errors
422: OUT_OF_STOCKOne or more SKUs in the request are no longer available in the required quantity.
401: INVALID_AUTHThe API key provided is expired or lacks 'order:write' permissions.