v1
latestOpenAPI 3.0.42026-07-2685196386.6 KBProduct
Search products
Searches products by query within the store. Requires the stores.products.view permission.
get/stores/{storeId}/products/search/{query}
Path parameters
storeIdstring uuid required
The ID of the store to search in.
querystring required
The search query.
Query parameters
Visibility0 | 1 | 2 | 3
List of product visibility (or privacy) levels
Filter by visibility (Public / Unlisted / Private / OnHold).
IsBestSellerboolean
Show only best-sellers (true) or non-best-sellers (false).
ShouldBlockVpnsboolean
Filter on whether VPNs are blocked for the product.
LowStockboolean
Filter by products that have low stock availability.
Filtersstring
Sortsstring
Pageinteger
PageSizeinteger
Response
The object was successfully returned.