Search
K
PublicApi

/suppliers/{supplier_id}

get
https://api.retailexpress.com.au/v1/suppliers/{supplier_id}

Path Parameters

supplier_idstringrequired

Headers

x-api-keystringrequired

Response

application/json

200 response

Supplier

A supplier of merchandise

codestring

The reference for the supplier

order_email_addressstring

The email address for purchase orders to be sent to

last_modified_onstring(date-time)

The date and time the record was last modified

namestring

The name of the supplier

contact_detailsobject

Contact details for an entity

Show Child Parameters
idstring

The id of the supplier

get/suppliers/{supplier_id}
 
application/json

/suppliers/{supplier_id}

options
https://api.retailexpress.com.au/v1/suppliers/{supplier_id}

Path Parameters

supplier_idstringrequired

Response

200 application/json

200 response

Empty

Emptyobject
options/suppliers/{supplier_id}
 
200 application/json

/financialsummaries/stocktransfers

get
https://api.retailexpress.com.au/v1/financialsummaries/stocktransfers

Query Parameters

date_fromstring
date_tostring
page_sizestring
page_numberstring
store_idsstring

Headers

x-api-keystringrequired

Response

application/json

200 response

Stock Transfer Summary Response

summary_linesarray[object]

A summary of stock transfers for a given store on a given date

Show Child Parameters
page_numberinteger

The current page number

total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

page_sizeinteger

The maximum number of records in a single page

get/financialsummaries/stocktransfers
 
application/json

/financialsummaries/stocktransfers

options
https://api.retailexpress.com.au/v1/financialsummaries/stocktransfers

Response

200 application/json

200 response

Empty

Emptyobject
options/financialsummaries/stocktransfers
 
200 application/json

/financialsummaries/sales

get
https://api.retailexpress.com.au/v1/financialsummaries/sales

Query Parameters

date_fromstring
date_tostring
page_sizestring
page_numberstring
store_idsstring

Headers

x-api-keystringrequired

Response

application/json

200 response

Sales Summary Response

summary_linesarray[object]

A summary of sales data for a given store on a given date

Show Child Parameters
page_numberinteger

The current page number

total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

page_sizeinteger

The maximum number of records in a single page

get/financialsummaries/sales
 
application/json