Search
K
Retail Express API 2.1

Retail Express API

v2.1OAS 3.0
API Base URL
  • Server 1:https://api.retailexpress.com.au/v2.1

countries

Searches Countries by parameters

Searches Countries by parameters

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

Query Parameters

codestring | null

Search by Code

namestring | null

Search by Name

modified_sincestring | null(date-time)

Modified since search parameter

order_bystring | null

Order by.

Available field name values: id (default), code, name, modified_on

Available direction values: asc, desc.

Example: modified_on desc

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

Paging Response with Countries data

Country.PagingResponse

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

CountryVM Model

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

Gets Country by id

Gets Country by id

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

Path Parameters

idinteger(int32)required

Country 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 Country

Country

CountryVM Model

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

id

codestring | null

code

namestring | null

name

tax_ratenumber(double)

tax_rate

tax_labelstring | null

tax_label

currency_multipliernumber(double)

currency_multiplier

fob_currencyobject

Currencies model

* Additional properties are NOT allowed.
Show Child Parameters
modified_onstring(date-time)

Modified on

get/countries/{id}
 
application/json

creditnotes