Retail Express API 2.1

Searches Barcodes by parameters

Searches Barcodes by parameters

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

Query Parameters

product_idinteger | null(int32)

Product Id

product_statusstring | null

Product status. Accepted values: “enabled”, “disabled”, not specified.

barcodestring | null

Product barcode name

enabledboolean | null

Product barcode enabled

created_sincestring | null(date-time)

Created since

modified_sincestring | null(date-time)

Modified since

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 Barcodes data

ProductBarcode.PagingResponse

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

Product Barcode model

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

productdetailslog

Searches Product Details Logs

Searches Product Details Logs

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

Query Parameters

plustring | null

Product Look-Up code (PLU) It can be Product Id, Supplier SKU, Manufacturer SKU, Supplier SKU 2 or any Barcodes for a product. If specified, product_id, product_supplier_sku, product_short_description, product_created_on filters are ignored.

movement_typesstring | null

Movement Type or Collection of Movement Types (comma separated).
Example: Product Initialisation,Product Details Edited

filter_bystring | null

Filter by.

Available field name values: id, created_on, product_id, product_supplier_sku, product_short_description, product_created_on, origin, supplier_buy_ex_before, supplier_buy_ex_change, supplier_buy_ex_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, sell_price_inc_before, sell_price_inc_change, sell_price_inc_after, discount_price_before, discount_price_change, discount_price_after, rrp_inc_before, rrp_inc_change, rrp_inc_after, web_price_inc_before, web_price_inc_change, web_price_inc_after, product_type_before, product_type_after, disabled_before, disabled_after.

In string values: ‘|’ and ‘,’ characters have to be escaped with slash, i.e. ‘\,’ ‘\|’

For operators that support multiple values (in, notin): multiple values are delimited using ‘|’ character

Available operators:

eq - Equal

neq - Not equals

lt - Less

lte - Less or equal

gt - Greater

gte - Greater or equal

in - In

notin - Not In

contains - Contains

isnull - Is Null

isnullorempty - Is Null Or Empty

isnotnull - Is Not Null

startswith - Starts with

endswith - Ends with

doesnotcontain - Does not contain

For non-nullable fields operators isnull and isnotnull are unavailable

For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable

For strings operators: lt, lte, gt, gte are unavailable

Example: created_on:gte:2021-06-03T05:48:09+10:00,product_id:in:124001|124002

order_bystring | null

Order by.

Available field name values: id, created_on, product_id, product_supplier_sku, product_short_description, product_created_on, movement_type, origin, supplier_buy_ex_before, supplier_buy_ex_change, supplier_buy_ex_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, sell_price_inc_before, sell_price_inc_change, sell_price_inc_after, discount_price_before, discount_price_change, discount_price_after, rrp_inc_before, rrp_inc_change, rrp_inc_after, web_price_inc_before, web_price_inc_change, web_price_inc_after, product_type_before, product_type_after, disabled_before, disabled_after.

Available direction values: asc, desc.

Example: id asc, created_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 Product Details Logs data

ProductDetailLog.PagingResponse

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

Product Detail Log model

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

Gets specific Product Details Log by unique id

Gets specific Product Details Log by unique id

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

Path Parameters

idinteger(int32)required

Product Details Log id

Example:1

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 Product Details Log

ProductDetailLog

Product Detail Log model

* Additional properties are NOT allowed.
idinteger(int32)

Id

created_onstring(date-time)

Created on

created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
productobject

Product Detail Log Product model

* Additional properties are NOT allowed.
Show Child Parameters
movement_typestring | null

Source type

originstring | null

Origin

supplier_buy_exobject
* Additional properties are NOT allowed.
Show Child Parameters
buy_price_exobject
* Additional properties are NOT allowed.
Show Child Parameters
direct_costs_exobject
* Additional properties are NOT allowed.
Show Child Parameters
sell_price_incobject
* Additional properties are NOT allowed.
Show Child Parameters
discount_priceobject
* Additional properties are NOT allowed.
Show Child Parameters
rrp_incobject
* Additional properties are NOT allowed.
Show Child Parameters
web_price_incobject
* Additional properties are NOT allowed.
Show Child Parameters
product_typeobject
* Additional properties are NOT allowed.
Show Child Parameters
disabledobject
* Additional properties are NOT allowed.
Show Child Parameters
get/productdetailslog/{id}
 
application/json

producteta