Search
K
Retail Express API 2.1

Searches Inventories by parameters

Searches Inventories by parameters

get
https://api.retailexpress.com.au/v2/inventory

Query Parameters

sales_channel_idstring | null

Sales Channel Id or Collection of Sales Channel Ids (comma separated)
Example: 14,3,312

skustring | null

Product SKU or Collection of Product SKUs (comma separated)
Example: sku1,sku2,sku3

outlet_idstring | null

Outlet Id or Collection of Outlet Ids (comma separated)
Example: 1,2,3

product_idstring | null

Product Id or Collection of Product Ids (comma separated)
Example: 1,2,3

modified_sincestring | null(date-time)

Modified since search parameter

page_numberinteger(int32)

Format - int32.

>= 1<= 100000

page_sizeinteger(int32)

Format - 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 Inventories data

Inventory.PagingResponse

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

Inventory view model

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

maxdiscountrules

Searches Max Discount Rules by parameters

Searches Max Discount Rules by parameters

get
https://api.retailexpress.com.au/v2/maxdiscountrules

Query Parameters

idsstring | null

Max discount rule Ids. (comma separated)
Other properties are skipped, if used.
Example: 2,3,4

namestring | null

Max discount rule name

modified_sincestring | null(date-time)

Modified since

order_bystring | null

Order by.

Available field name values: id (default), name, type, value, modified_on

Available direction values: asc, desc.

Example: name asc, type asc, modified_on desc

page_numberinteger(int32)

Format - int32.

>= 1<= 100000

page_sizeinteger(int32)

Format - 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 Max Discount Rules data

MaxDiscountRule.PagingResponse

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

Max Discount Rule Model

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

Gets specific Max Discount Rule by unique id

Gets specific Max Discount Rule by unique id

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

Path Parameters

idinteger(int32)required

Max Discount Rule id

Example:10

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 Max Discount Rule

MaxDiscountRule

Max Discount Rule Model

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

Max Discount Rule Id.

namestring | null

Max Discount Rule name.

>= 0 characters<= 50 characters

valuenumber(double)

Max Discount Rule value.

typestring | null

Discount Type.

modified_onstring(date-time)

Modified on

get/maxdiscountrules/{id}
 
application/json

orderfulfilments