Order
objectOrder Model
* Additional properties are NOT allowed.
billing_addressobject
Billing address model
* Additional properties are NOT allowed.
Show Child Parameters
private_commentsstring
delivery_addressobject
Delivery Address model
* Additional properties are NOT allowed.
Show Child Parameters
ext_unique_idstring
External ID of the payment, if applicable.
freight_totalnumber(double)
Freight total
freight_typeobject
* Additional properties are NOT allowed.
Show Child Parameters
idinteger(int32)
Order Id.
customerobject
* Additional properties are NOT allowed.
Show Child Parameters
order_numberstring
The Order identifier in Retail Express.
original_order_idinteger(int32)
Original Order Id.
sales_channelobject
* Additional properties are NOT allowed.
Show Child Parameters
sales_personobject
* Additional properties are NOT allowed.
Show Child Parameters
order_statusobject
* Additional properties are NOT allowed.
Show Child Parameters
order_totalnumber(double)
Order total
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
public_commentsstring
Public comments
taxableinteger(int32)read-only
Is taxable
created_onstring(date-time)
Created on
modified_onstring(date-time)
Modified on
fulfilled_in_full_onstring(date-time)
Fulfilled in full on
paid_in_full_onstring(date-time)
Paid in full on
order_itemsarray[object]
Order Item Model
* Additional properties are NOT allowed.
Show Child Parameters
fulfilmentsarray[object]
Fulfilment model
* Additional properties are NOT allowed.
Show Child Parameters
paymentsarray[object]
Order Payment Model
* Additional properties are NOT allowed.
Show Child Parameters
vouchersarray[object]
Vouchers.
* Additional properties are NOT allowed.
Show Child Parameters
Example
Order.PagingResponse
object * Additional properties are NOT allowed.
dataarray[object]
Order Model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example
OrderItem
objectOrder Item Model
* Additional properties are NOT allowed.
idinteger(int32)
Order item id.
external_idstring
External unique id
order_item_typestring
Order item type
productobject
* Additional properties are NOT allowed.
Show Child Parameters
original_pricenumber(double)
Original price
sell_pricenumber(double)
Sell price
order_item_totalnumber(double)read-only
Order item total
order_item_discount_totalnumber(double)
Order item discount total
taxableboolean
Is taxable
tax_ratenumber(double)
Tax rate
supplier_buy_exnumber(double)
Supplier Buy Ex
direct_costs_exnumber(double)
Direct Costs Ex
cogs_exnumber(double)read-only
COGS Ex
fulfilment_methodstring
Fulfilment Method
due_datestring(date-time)
Due date
delivery_driverobject
* Additional properties are NOT allowed.
Show Child Parameters
delivery_zoneobject
* Additional properties are NOT allowed.
Show Child Parameters
delivery_timeobject
* Additional properties are NOT allowed.
Show Child Parameters
quantity_orderedinteger(int32)
Quantity Ordered
quantity_fulfiledinteger(int32)
Quantity Fulfiled
notesstring
Notes
original_order_item_idinteger(int32)
Original Order Item Id
return_reasonobject
Return Reason Limited Model
* Additional properties are NOT allowed.
Show Child Parameters
fulfil_outletobject
* Additional properties are NOT allowed.
Show Child Parameters
source_outletobject
* Additional properties are NOT allowed.
Show Child Parameters
applied_promotional_campaignsarray[object]
Campaign Model
* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)
Created on
modified_onstring(date-time)
Modified on
linked_purchase_orderobject
Purchase order model
* Additional properties are NOT allowed.
Show Child Parameters
serial_numberstring
Serial Number
Example
OrderItem.PagingResponse
object * Additional properties are NOT allowed.
dataarray[object]
Order Item Model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example
OrderLimited
object * Additional properties are NOT allowed.
idinteger(int32)
Order Id.
customerobject
* Additional properties are NOT allowed.
Show Child Parameters
order_numberstring
The Order identifier in Retail Express.
original_order_idinteger(int32)
Original Order Id.
created_onstring(date-time)
Created on
vouchersarray[object]
Vouchers.
* Additional properties are NOT allowed.
Show Child Parameters
Example