Shopping Search
POST

ShoppingSearchEntity child of SearchEntity
Example
Request
The search query string to be used for retrieving web search results.Restrictions:
| Role | Description |
|---|---|
| Max characters | 100 characters |
| Min characters | 1 character |
The maximum number of search results to return.Restrictions:
| Role | Description |
|---|---|
| Min value | 1 |
| Max value | 10 |
The ISO 3166-1 alpha-2 country code to tailor search results to a specific country.
The ISO 639-1 language code to specify the language of the search results.
An array specifying which fields to include in the shopping search results.
Possible values are:
'title': The title of the product.'link': The URL link to the product page.'price': The current price of the product.'oldPrice': The old price of the product (if available).'shop': The name of the shop or seller.'distance': The distance to the shop (if applicable).'totalReviews': The total number of reviews for the product.'position': The position of the product in the search results.
An optional object to configure caching behavior for the request. By default, caching is enabled with a TTL of 120 seconds. You can customize these settings by providing the
cache object.Response
Indicates whether the response was served from cache.
The time in seconds until the cached response expires. Default is 7200
seconds (2 hours).
An array of shopping search result entities matching the search query.