idinteger(int32)required
Fulfilment id
Gets specific Order Fulfilment
Gets specific Order Fulfilment
get
https://api.retailexpress.com.au/v2/orderfulfilments/{id}
Path Parameters
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
application/json
Returns found Order Fulfilment
ExtendedFulfilment
Fulfilment model
* Additional properties are NOT allowed.
idinteger(int32)
Fulfilment id
order_item_idinteger(int32)
Order Item Id
quantity_fulfiledinteger(int32)
Fulfiled quantity of products
fulfil_outletobject
Order Fulfilment Outlet Model
* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)
Created On
order_idinteger | null(int32)
Order Id .
order_numberstring | null
Order Number.
get/orderfulfilments/{id}
Path Parameters
Headers
application/json
orderitems
Searches Order Items by parameters
Searches Order Items by parameters
get
https://api.retailexpress.com.au/v2/orderitems
Query Parameters
idstring | null
Order Item Id or Collection of Order Item Ids (comma separated)
Example: 1,2,3
order_idstring | null
Order Id or Collection of Order Ids (comma separated)
Example: 1,2,3
order_numberstring | null
Order Number or Collection of Order Numbers (comma separated)
Example: 1,2,3
order_item_typestring | null
Order Item Type or Collection of Order Item Types (comma separated)
Example: 1,2,3
fulfil_outletstring | null
Fulfilment Outlet or Collection of Fulfilment Outlets (comma separated)
Example: 1,2,3
source_outletstring | null
Source Outlet or Collection of Source Outlets (comma separated)
Example: 1,2,3
created_sincestring | null(date-time)
Created since
modified_sincestring | null(date-time)
Modified since
order_bystring | null
Order by.
Available field name values: id, order_id, order_number, order_item_type, fulfil_outlet, source_outlet, created_on, modified_on
Available direction values: asc, desc.
Example: order_id asc, order_number desc
page_numberinteger(int32)
Format - int32.
>= 1<= 100000
page_sizeinteger(int32)
Format - int32.
>= 1<= 2147483647
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
application/json
Paging Response with Order Items data
ExtendedOrderItem.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Order Item Model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/orderitems
Query Parameters
Headers
application/json
Gets specific Order Item
Gets specific Order Item
get
https://api.retailexpress.com.au/v2/orderitems/{id}
Path Parameters
idinteger(int32)required
Order Item id
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
application/json
Returns found Order Item
ExtendedOrderItem
Order Item Model
* Additional properties are NOT allowed.
idinteger | null(int32)
Order item id.
external_idstring | null
External unique id
order_item_typestring | null
Order item type
productobject
Order Item Product View Model
* Additional properties are NOT allowed.
Show Child Parameters
original_pricenumber | null(double)
Original price
sell_pricenumber(double)
Sell price
order_item_totalnumber(double)read-only
Order item total
order_item_discount_totalnumber | null(double)
Order item discount total
taxableboolean | null
Is taxable
tax_ratenumber | null(double)
Tax rate
supplier_buy_exnumber | null(double)
Supplier Buy Ex
direct_costs_exnumber | null(double)
Direct Costs Ex
cogs_exnumber | null(double)read-only
COGS Ex
fulfilment_methodstring | null
Fulfilment Method
due_datestring | null(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 | null[object]
Campaign Model
* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)
Created on
modified_onstring | null(date-time)
Modified on
linked_purchase_orderobject
* Additional properties are NOT allowed.
Show Child Parameters
order_idinteger(int32)
Order Id .
order_numberstring | null
Order Number.
get/orderitems/{id}
Path Parameters
Headers
application/json