Search
GET /search?search_type=shopping
The Google Shopping Parameters are applicable when making a request with search_type=shopping to retrieve Shopping results for a given search term. The search term is specified in the q parameter and the optional location parameter can be used to geo-locate the shopping request (locations can be retrieved via the Locations API).
For example, to request shopping results for the keyword pizza in the location United States , the request would be:
The following parameters are available for all requests made when search_type=shopping .
Parameter | Required | Description |
|---|---|---|
search_type | required | Should be set to search_type=shopping . |
q | required | The keyword you want to use to perform the Shopping search. |
location | optional | Determines the geographic location in which the query is executed. You can enter any location as free-text, but if you choose one of the Scale SERP built-in locations then the google_domain , gl and hl parameters are automatically updated to the domain, country and language that match the built-in location (note that this behaviour can be disabled via the location_auto parameter). |
location_auto | optional | If the location field is set to a Scale SERP built-in location from the Locations API , and location_auto is set to true (default) then the google_domain , gl and hl parameters are automatically updated to the domain, country and language that match the built-in location. Valid values are true (default) to enable this behaviour or false to disable. |
uule | optional | The Google UULE parameter - use to pass through a custom uule parameter to Google. Scale SERP automatically generates the uule when you use the location parameter but we allow you to overwrite it directly by specifying a uule directly. |
google_domain | optional | The Google domain to use to run the search query. View the full list of supported google_domain values here . Defaults to google.com . |
gl | optional | The gl parameter determines the Google country to use for the query. View the full list of supported gl values here . |
hl | optional | The hl parameter determines the Google UI language to return results. View the full list of supported hl values here . |
page | optional | Determines the page of results to return, defaults to 1 . Use in combination with the num parameter to implement pagination. |
max_page | optional | Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response. See the Pagination docs for more information. |
num | optional | Determines the number of results to show per page. Use in combination with the page parameter to implement pagination. Note the num parameter is not always honoured by Google for search_type=shopping requests. When using the num parameter you are requesting that number of results per page. There is no guarantee that that number of results will necessarily be served. |
sort_by | optional | Sets the sort ordering of the shopping results returned. Valid values are:
|
shopping_buy_on_google | optional | Determines whether the "Buy on Google" option is selected when running a search_type=shopping search. Valid values are true or false .
|
shopping_filter | optional | A shopping filter (i.e. "Brand") to filter the results to. Shopping filter values are returned in the filters property of the shopping response .
|
shopping_price_min | optional | The minimum price of products. For example shopping_price_min=4.99 |
shopping_price_max | optional | The maximum price of products returned. For example shopping_price_max=29.99 |
shopping_condition | optional | The condition of products returned. Can be set to new or used . |
shopping_merchants | optional | A comma-separated list of merchant IDs to retrieve shopping results. Merchant ID's can be found in the merchagg: section of any Google Shopping URL. |
Next Steps Google Shopping Results