Search
K
PublicApi

/stores

get
https://api.retailexpress.com.au/v1/stores

Query Parameters

page_sizestring
page_numberstring
modified_sincestring

Headers

x-api-keystringrequired

Response

application/json

200 response

Store List Response

page_numberinteger

The current page number

storesarray[object]

A retail store/outlet

Show Child Parameters
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/stores
 
application/json

/stores

options
https://api.retailexpress.com.au/v1/stores

Response

200 application/json

200 response

Empty

Emptyobject
options/stores
 
200 application/json

/paymenttypes

get
https://api.retailexpress.com.au/v1/paymenttypes

Query Parameters

page_sizestring
page_numberstring
modified_sincestring

Headers

x-api-keystringrequired

Response

application/json

200 response

PaymentTypeListResponse

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

payment_typesarray[object]

A payment type

Show Child Parameters
page_sizeinteger

The maximum number of records in a single page

get/paymenttypes
 
application/json

/paymenttypes

options
https://api.retailexpress.com.au/v1/paymenttypes

Response

200 application/json

200 response

Empty

Emptyobject
options/paymenttypes
 
200 application/json

/financialsummaries/pettycash

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

Query Parameters

date_fromstring
date_tostring
page_sizestring
page_numberstring
store_idsstring

Headers

x-api-keystringrequired

Response

application/json

200 response

Petty Cash Summary Response

summary_linesarray[object]

A summary of POS money in and out 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/pettycash
 
application/json