Merchant

‌‌ Google Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. The provided data for each seller includes related product base and total price, shipment and purchase details and special offers. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.

post/v3/merchant/google/sellers/task_post

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/merchant/google/sellers/task_post
  • Auth: HTTP basic

Request body

product_idstring

<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>

data_docidstring

<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>

gidstring

<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" rel="noopener noreferrer" target="_blank">this help center guide</a>

pvfstring nullable

<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>

priorityinteger nullable

<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/google-shopping-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.

location_namestring

<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>

location_codeinteger

<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">2840</code>

location_coordinatestring

<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>

language_namestring

<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class="long-string">English</code>

language_codestring

<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>

depthinteger nullable

<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/google-shopping-api" target="_blank" rel="noopener noreferrer">Pricing</a> page

se_domainstring nullable

<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.

get_shops_on_googleboolean nullable

<em>include "buy on Google" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled

additional_specificationsobject nullable

<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>"additional_specifications</code> object, which you can get by making a separate request to the <a href="/v3/merchant/google/products/task_post">Google Shopping Products endpoint</a><br>example:<br><code>"additional_specifications": {<br>"eto": "16157121050167572763_0"<br>}</code>

tagstring nullable

<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response

postback_urlstring nullable

<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>

postback_datastring nullable
pingback_urlstring nullable

<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>

Example request

[
  {
    "language_code": "en",
    "location_code": 2840,
    "product_id": "1113158713975221117"
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

general status code you can find the full list of the response codes here

status_messagestring nullable

general informational message you can find the full list of general informational messages here

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

the number of tasks in the tasks array returned with an error

Changes

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////