Retail Express API 2.1

Gets specific Transfer Item by unique id

Gets specific Transfer Item by unique id

get
https://api.retailexpress.com.au/v2.1/transfers/{id}/transferitems/{item_id}

Path Parameters

idinteger(int32)required

Transfer id

item_idinteger(int32)required

Transfer 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

Returns found Transfer Item

Transfer

Transfer model

* Additional properties are NOT allowed.
idinteger | null(int32)

Transfer Identifier

statusobject

Transfer Status

* Additional properties are NOT allowed.
Show Child Parameters
transfer_typeobject

Transfer Type

* Additional properties are NOT allowed.
Show Child Parameters
outlet_fromobject
* Additional properties are NOT allowed.
Show Child Parameters
outlet_toobject
* Additional properties are NOT allowed.
Show Child Parameters
notesstring | null

Notes

approvedboolean

Approved

approved_byobject
* Additional properties are NOT allowed.
Show Child Parameters
purchase_orderobject

Purchase order model

* Additional properties are NOT allowed.
Show Child Parameters
orderobject
* Additional properties are NOT allowed.
Show Child Parameters
created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)

Created On

modified_onstring | null(date-time)

Modified On

total_picked_buy_price_exnumber | null(double)

Total Picked Buy Price Ex

total_picked_direct_costs_exnumber | null(double)

Total Picked Direct Costs Ex

total_picked_cogs_exnumber | null(double)

Total Picked Cogs Ex

transfer_itemsarray | null[object]

Transfer Item model

* Additional properties are NOT allowed.
Show Child Parameters
simple_modeboolean

Simple Mode

get/transfers/{id}/transferitems/{item_id}
 
application/json

transferstatus

Searches Transfer Statuses by parameters

Searches Transfer Statuses by parameters

get
https://api.retailexpress.com.au/v2.1/transferstatus

Query Parameters

page_numberinteger(int32)

>= 1<= 100000

page_sizeinteger(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

Returns Transfer Statuses

TransferStatus.PagingResponse

* Additional properties are NOT allowed.
dataarray | null[object]

Transfer Status

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/transferstatus
 
application/json

Gets specific Transfer Status by unique id

Gets specific Transfer Status by unique id

get
https://api.retailexpress.com.au/v2.1/transferstatus/{id}

Path Parameters

idinteger(int32)required

Transfer Status id

Example:1

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

application/json

Returns found Transfer Status

TransferStatus

Transfer Status

* Additional properties are NOT allowed.
idinteger(int32)

Id

namestring | null

Type Name

get/transferstatus/{id}
 
application/json

transfertypes