idinteger(int32)required
Order id
fulfilment_idinteger(int32)required
Fulfilment id
Gets specific Order Fulfilment
Gets specific Order Fulfilment
get
https://api.retailexpress.com.au/v2/orders/{id}/fulfilments/{fulfilment_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
Fulfilment
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
get/orders/{id}/fulfilments/{fulfilment_id}
Path Parameters
Headers
application/json
Searches Order Items by parameters
Searches Order Items by parameters
get
https://api.retailexpress.com.au/v2/orders/{id}/orderitems
Query Parameters
created_sincestring | null(date-time)
Created since
modified_sincestring | null(date-time)
Modified since
page_numberinteger(int32)
Format - int32.
>= 1<= 100000
page_sizeinteger(int32)
Format - int32.
>= 1<= 2147483647
Path Parameters
idinteger(int32)required
Order 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
Paging Response with Order Items data
OrderItem.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/orders/{id}/orderitems
Path Parameters
Query Parameters
Headers
application/json
Gets specific Order Item
Gets specific Order Item
get
https://api.retailexpress.com.au/v2/orders/{id}/orderitems/{item_id}
Path Parameters
idinteger(int32)required
Order id
item_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
OrderItem
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
get/orders/{id}/orderitems/{item_id}
Path Parameters
Headers
application/json
Searches Order Payments by parameters
Searches Order Payments by parameters
get
https://api.retailexpress.com.au/v2/orders/{id}/payments
Query Parameters
created_sincestring | null(date-time)
Created since
page_numberinteger(int32)
Format - int32.
>= 1<= 100000
page_sizeinteger(int32)
Format - int32.
>= 1<= 2147483647
Path Parameters
idinteger(int32)required
Order 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
Paging Response with Order Payments data
OrderPayment.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Order Payment Model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/orders/{id}/payments
Path Parameters
Query Parameters
Headers
application/json
Gets specific Order Payment
Gets specific Order Payment
get
https://api.retailexpress.com.au/v2/orders/{id}/payments/{payment_id}
Path Parameters
idinteger(int32)required
Order id
payment_idinteger(int32)required
Payment 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 Payment
OrderPayment
Order Payment Model
* Additional properties are NOT allowed.
idinteger(int32)
Order Payment Id .
external_idstring | null
External Id.
payment_methodobject
Payment Method Model
* Additional properties are NOT allowed.
Show Child Parameters
amountnumber(double)
Amount.
created_onstring(date-time)
Created On.
get/orders/{id}/payments/{payment_id}
Path Parameters
Headers
application/json