🚧
Warning
This API supports only Basic Authentication.

Search Query String

Attributes like price, item_sku, description, img_url are common for all the orgs.

Standard Query: attribute:OPERATOR:value

Search Query String is the URL encoded string containing the parameters used for searching. You can pass multiple params in the query with fixed operators separating each query string with |

For instance, assume that you want to retrieve all the products which matches any of the following

Color: Black, blue, or green
Size XL,
Price range: 2000 - 4000
Department: Men

Then the query string would be as shown below:

q=(color:IN:Black;Blue;Green|size:EQUALS:XL|price:RANGE:2000;4000|department:EQUALS:Men)

URL Encoded String:

color%3AIN%3ABlack%3BBlue%3BGreen%7Csize%3AEQUALS%3AXL%7Cprice%3ARANGE%3A2000%3B4000%7Cdepartment%3AEQUALS%3AMen

Request URL: https:\{host\}/v1.1/product/search?q=(color%3ain%3ablack%3bblue%3bgreen%7csize%3aequals%3axl%7cprice%3arange%3a2000%3b4000%7cdepartment%3aequals%3amen)&format={xml/json}

The following characters are not supported in search queries as they have a special meaning in search grammar.

+ - && || ! ( ) {{}} [ ] ^ " ~ * ? : \

Response Parameters

Parameter	Datatype	Description
id	long	Unique ID of the product generated by the system.
sku	string	SKU of the product.
ean	string	European article number of the product.
price	double	Price of the product.
org_id	long	Unique ID of the current org.
description	string	Brief description of the product.
img_url	string	URL of the product image.
attributes	obj	Attributes of the product in name-value pairs.
added_on	date-time	Date and time of the product addition.
ou_id	integer	Indicates the ID of the OU. -1 indicates that the product belongs to a master org. This is applicable only if OU support for product inventory is enabled.