GET
/v1/products/searchSearch products
Searches products that you previously created using the Search Query Language. Use query to define the search expression and page to continue through result pages; search results can lag behind recently created or updated data.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
expandarray<string>optional
Specifies response fields to expand.
limitintegeroptional
The number of matching products to return. Must be between 1 and 100 and defaults to 10 when omitted.
pagestringoptional
A pagination cursor from a previous response's `next_page` value. Omit it on the first request.
querystringrequired
The Search Query Language expression used to filter products. Must be no longer than 5000 characters.
200Returns a search result containing matching product objects, pagination fields, the result object type, the total matching count, and the result URL.
dataarray<Product>required
has_morebooleanrequired
next_pagestringoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
total_countintegeroptional
The total number of objects that match the query, only accurate up to 10,000.
urlstringrequired
defaultReturns an error object containing an error type and details about the failed request.
errorobjectrequired
Error handling
query is required and must be a search expression no longer than 5000 characters. limit must be between 1 and 100 and defaults to 10 when omitted. Do not use this endpoint when strict read-after-write consistency is required.