Search products

Session unique identifier. It is recommended to use this package to generate UUID.

The search query. This parameter is required for the semantic search scenario.

URL of the image. This parameter is required for the visual search scenario. Note: Either image_url or image_base64 must be provided, but not both.

Base64-encoded image data. This parameter is required for the visual search scenario. Note: Either image_url or image_base64 must be provided, but not both.

Include products that correspond to the specified attribute. For the supported filter key, please refer to the filter key, and for the format of the filter, please refer to the following examples:

• Conjunctive filtering: ["tags:Sale", "price:[48,56)"] means tags contain any of ('Sale') and price greater than or equal to 48 and less than 56
• Disjunctive filtering: ["tags:Sofa,Couch,Bed"] means tags contain any of ('Sofa', 'Couch', 'Bed')

Exclude products that correspond to the specified attribute. For the supported filter key, please refer to the filter key, and for the format of the filter, please refer to the following examples:

• Conjunctive filtering: ["!tags:Sale", "!categories:Furniture"] means tags not contain any of ('Sale') and categories not contain any of ('Furniture')
• Disjunctive filtering: ["!tags:Sofa,Couch,Bed"] means tags not contain any of ('Sofa', 'Couch', 'Bed')

To apply multiple filters along certain discrete attributes or facets of the overall data collection. Selecting fewer facets for aggregation may help improve retrieval speed. For supported facets, please refer to filter key.

To specify sort order based on attribute values of the requested resource instances, and for multiple sort attributes, separate the sort attributes by commas (,) in the "sort" request parameter.

• Ascending order: For example, use +relevance to control the returned products to be sorted in ascending order of the relevance.
• Dscending order: For example, use -price,-relevance to control the returned products to be sorted in descending order of the price, and within each group of products with the same price, products are sorted in descending order of the relevance attribute.

Support sort attributes: relevance, title, price, created_at, updated_at

The page to query. Maximum page number is bounded by total number of queried products.

The number of products each page contains.