Search
K
Retail Express API 2.1

OrderItemOutlet

object

Order Item Outlet Model

* Additional properties are NOT allowed.
idinteger(int32)

Outlet id

namestring

Outlet name

>= 0 characters<= 255 characters

modified_onstring(date-time)

Modified on

Example

Campaign

object

Campaign Model

* Additional properties are NOT allowed.
idinteger(int32)

Campaign id

namestring

Campaign name

>= 0 characters<= 100 characters

Example

OrderPurchaseOrderStatus

object
* Additional properties are NOT allowed.
idinteger(int32)

Status identifier

namestring

Status name

Example

OrderPurchaseOrder

object
* Additional properties are NOT allowed.
idinteger(int32)

PO Id

statusobject
* Additional properties are NOT allowed.
Show Child Parameters
etastring(date-time)

ETA

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

Example

OrderItem

object

Order Item Model

* Additional properties are NOT allowed.
idinteger(int32)

Order item id.

external_idstring

External unique id

order_item_typestring

Order item type

productobject

Order Item Product View Model

* 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

fulfil_outletobject

Order Item Outlet Model

* Additional properties are NOT allowed.
Show Child Parameters
source_outletobject

Order Item Outlet Model

* 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
* Additional properties are NOT allowed.
Show Child Parameters
Example