Orders are a request to send a specific collection and quantities of items to a specified shipping address to fulfil a sale of goods made or to deliver the items to another other desired destination.
The most common example is an outbound Order request to send a specific collection of items to a specific address to fulfil a sale of goods made to that end receiver.
The order object includes fields with reference numbers, shipping address details, and shipping data.
Each Order object will also include an ItemLines array of objects which hold the relevant data about each item to be moved out of inventory.
Order properties are detailed below
Property Name | Description |
|---|
id | "id": "3b717016-fbcf-11e5-8122-4b7d6946cb70"
Unique order identifier in UUID format. string (system generated) |
external_id | "external_id": "1000002568"
Unique order id from your external system string (required) |
type | "type": "Sales Order"
Order Type string (required) |
channel | "channel": "Shopify"
Sales channel name string (optional) |
status | "status": "Waiting"
Status of this order:
- Waiting - order is in queue waiting to begin processing
- Processing - order processing has begun
- Hold - order is on hold
- Complete - order has been completed
string (system generated) |
currency | "currency": "AUD"
Currency code in ISO 4217 format string (required) |
reference | "reference": "SO#10012345"
Unique order reference - may be the same as external_id string (required) |
line_items | "line_items": [{
"line_number": 1,
"sku": "ABC123",
"description": "Blue Widget",
"qty_ordered": 10,
"qty_shipped": 0,
"requires_shipping": true,
"unit_price": 14.95
}]
Array of line_item objects. Each line_item object contains the following properties:
- line_number - optional unique line number or reference for this line. Will default to autoincrementing value if not set. Can be used to reference shipment line items to order line items.
- sku - the unique sku code for the item ordered
- description - the description for the item ordered
- qty_ordered - the qty ordered of this item by the customer
- qty_shipped - the qty shipped of this item by the warehouse (Read Only)
- requires_shipping - boolean indicating if this is a physical product and is required to be shipped out of the warehouse.
- unit_price - the price of the items sold to the customer
array (required) |
billing_address | "billing_address": {
"company_name": "Invenco Pty Ltd",
"contact_email": "[email protected]",
"contact_name": "Dave Scott",
"contact_number": "02 9043 6013",
"billing_reference": "PO4567",
"address1": "Unit 2",
"address2": "1 Secombe Place",
"city": "Moorebank",
"postcode": "2170",
"state": "NSW"
"country": "AU"
}
An object containing billing address details. object (required) |
shipping_address | "shipping_address": {
"company_name": "Invenco Pty Ltd",
"contact_email": "[email protected]",
"contact_name": "Dave Scott",
"contact_number": "02 9043 6013",
"shipping_reference": "PO4567",
"address1": "Unit 2",
"address2": "1 Secombe Place",
"city": "Moorebank",
"postcode": "2170",
"state": "NSW",
"country": "AU"
}
An object containing shipping address details. object (required) |
shipping_rule | "shipping_rule": {
"name": "Standard Shipping",
"recovery": 12.95
}
An object containing shipping rule details. This rule drives service and delivery settings. object (required) |
tax_rule | "tax_rule": {
"name": "GST",
"inclusive": true,
"rate": 0.1}
An object containing tax rule details. This rule describes the tax rates applicable to prices on the order and whether or not the tax is included in the prices shown. object (required) |
account_id | "account_id": "72717016-fbcf-11e5-8122-4b7d6946cb54"
Unique account identifier in UUID format. string (system generated / read only) |
created | "created": 1500906789123
Created timestamp in UNIX Milliseconds format integer (system generated / read only) |
updated | "updated": 1500906789123
Updated timestamp in UNIX Milliseconds format integer (system generated / read only) |
