Search
K
PublicApi

PublicApi

0.1.0OAS 3.0

Please use the API Explorer to interact with our API resources without having to implement any logic. All you need is your API key to get started.

API Base URL
  • Server 1:https://api.retailexpress.com.au/{basePath}
    Variables
    basePath:
Security
api_key (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called x-api-key.

Example: x-api-key: 123

/financialsummaries/purchaseorders

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

Query Parameters

date_fromstring
date_tostring
page_sizestring
page_numberstring
store_idsstring

Headers

x-api-keystringrequired

Response

application/json

200 response

PurchaseOrderListResponse

page_numberinteger

The current page number

purchase_ordersarray[object]

A purchase order

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/financialsummaries/purchaseorders
 
application/json

/financialsummaries/purchaseorders

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

Response

200 application/json

200 response

Empty

Emptyobject
options/financialsummaries/purchaseorders
 
200 application/json

/financialsummaries/supplierinvoices

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

Query Parameters

date_fromstring
date_tostring
page_sizestring
page_numberstring
supplier_invoice_date_tostring
supplier_invoice_date_fromstring
store_idsstring

Headers

x-api-keystringrequired

Response

application/json

200 response

SupplierInvoiceListResponse

supplier_invoicesarray[object]

A supplier invoice

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/supplierinvoices
 
application/json