Marketing
objectMarketing view model
* Additional properties are NOT allowed.
receive_emailboolean
Receive email
receive_postboolean
Receive post
receive_smsboolean
Receive sms
Example
MaxDiscountRule
objectMax Discount Rule Model
* Additional properties are NOT allowed.
idinteger(int32)
Max Discount Rule Id.
namestring
Max Discount Rule name.
>= 0 characters<= 50 characters
valuenumber(double)
Max Discount Rule value.
typestring
Discount Type.
modified_onstring(date-time)
Modified on
Example
MaxDiscountRule.PagingResponse
object * Additional properties are NOT allowed.
dataarray[object]
Max Discount Rule Model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example
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