| Field | Type | Description | Validation |
|---|---|---|---|
billing_address | object | The address of the customer billed for this order. See Address. | Required |
currency | string | The currency used for transactions in this order. | Required |
customer | object | The customer's contact details. See Customer. | Required |
deliver_by | string | The date and time by which the order should be delivered. | - |
fulfillments | array of objects | The fulfillments that belong to this order, listed as an array. Delivery Hub displays each fulfillment only in the shipping location where a packer will fulfill that part of the order. See Fulfillment. | Required |
id | number (double) | The ID of this object in Delivery Hub. | Valid UUID |
items_count | number (double) | The total number of items included in this object. | - |
name | string | The order name, often formatted as a combination of OMS name, ID number, timestamp, or carrier. | 1-225 characters |
notes | array | Additional order details, such as additional address instructions. | 2-225 characters |
products | array of objects | The products included in this order. See Product. | Required |
source_id | string | Your source system's ID for this order. | - |
status | string | The status of this order in Delivery Hub. | - |
tip | number (double) | The tip (gratuity) paid to the driver by the customer. | - |
total_price | number (double) | The total price of this order, used for shipping rules and display in customer-facing documentation. | Required, Positive integer |
total_weight | number (double) | The total weight of all products in this order. | - |
user_id | number (double) | When relevant, the ID of the user who implemented a change. For example, this could be the ID of the user who created a shipment. | Valid UUID |