merchant/amazon/asin/live/advanced

Live Amazon ASIN Advanced

‌‌
This endpoint will provide you with a full list of ASINs assigned to different modifications of a product.

POST

Your account will be charged only for setting a task.
The cost can be calculated on the Pricing page.

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, each Live SERP API call can contain only one task.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name	Type	Description
`asin`	string	product ID required field unique product identifier (ASIN) in Amazon you can receive the `asin` parameter by making a separate request to the Amazon Products endpoint
`location_name`	string	full name of search engine location required field if you don't specify `location_code` or `location_coordinate` if you use this field, you don't need to specify `location_code` or `location_coordinate` you can receive the list of available locations with their `location_name` parameters by making a separate request to the `https://api.dataforseo.com/v3/merchant/amazon/locations` example: `HA1,England,United Kingdom`
`location_code`	integer	search engine location code required field if you don't specify `location_name` or `location_coordinate` if you use this field, you don't need to specify `location_name` or `location_coordinate` you can receive the list of available locations with their `location_code` parameters by making a separate request to the `https://api.dataforseo.com/v3/merchant/amazon/locations` example: `9045969`
`location_coordinate`	string	GPS coordinates of a location required field if you don't specify `location_name` or `location_code` if you use this field, you don't need to specify `location_name` or `location_code` `location_coordinate` parameter should be specified in the "latitude,longitude,radius" format the maximum number of decimal digits for "latitude" and "longitude": 7 the minimum value for "radius": 199.9 example: `53.476225,-2.243572,200`
`language_name`	string	full name of search engine language required field if you don't specify `language_code` if you use this field, you don't need to specify `language_code` you can receive the list of available languages with their `language_name` parameters by making a separate request to the `https://api.dataforseo.com/v3/merchant/amazon/languages` example: `English (United Kingdom)`
`language_code`	string	search engine language code required field if you don't specify `language_name` if you use this field, you don't need to specify `language_name` you can receive the list of available languages with their `language_code` parameters by making a separate request to the `https://api.dataforseo.com/v3/merchant/amazon/languages` example: `en_GB`
`se_domain`	string	search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: `amazon.com`, `amazon.co.uk`, `amazon.fr`, etc.
`tag`	string	user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response

‌‌‌‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name	Type	Description
`version`	string	the current version of the API
`status_code`	integer	general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
`status_message`	string	general informational message you can find the full list of general informational messages here
`time`	string	execution time, seconds
`cost`	float	total tasks* cost, USD*
`tasks_count`	integer	the number of tasks in the `tasks`* array*
`tasks_error`	integer	the number of tasks in the `tasks`* array that were returned an error*
`tasks`	array	array of tasks
`id`	string	task identifier unique task identifier in our system in the UUID format
`status_code`	integer	status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
`status_message`	string	informational message of the task you can find the full list of general informational messages here
`time`	string	execution time, seconds
`cost`	float	cost of the task, USD
`result_count`	integer	number of elements in the `result` array
`path`	array	URL path
`data`	object	contains the same parameters that you specified in the POST request
`result`	array	array of results
`asin`	string	ASIN received in a POST array the unique product identifier in Amazon (ASIN) received in a POST array learn more about the identified in this help center guide
`type`	string	search engine type in a POST array possible values: `shopping`
`se_domain`	string	Amazon domain in a POST array
`location_code`	integer	location code in a POST array
`language_code`	string	language code in a POST array
`check_url`	string	direct URL to Amazon results you can use it to make sure that we provided accurate results
`datetime`	string	date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00`
`spell`	object	autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection
`item_types`	array	types of search results found on Amazon contains types of all search results (`items`) found in the returned SERP possible item types: `amazon_product_info`
`items_count`	integer	the number of results returned in the `items`* array*
`items`	array	Amazon product info items
`type`	string	type of element = 'amazon_product_info'
`rank_group`	integer	position within a group of elements with identical `type` values positions of elements with different `type` values are omitted from `rank_group`
`rank_absolute`	integer	absolute rank absolute position among all the elements in the response array
`position`	string	the alignment of the element in Amazon SERP possible values: `left`, `right`
`xpath`	string	the XPath of the element
`title`	string	product title
`details`	string	product specs and other details
`image_url`	string	the URL of the product image
`author`	string	product brand name
`data_asin`	string	ASIN of the product received in a POST array
`parent_asin`	string	parent ASIN of the product
`product_asins`	array	ASINs of all found product modifications
`price_from`	float	the lower limit of the product price range example: `49.98`
`price_to`	float	the upper limit of the product price range example: `384.99`
`percentage_discount`	float	value of the percentage discount
`currency`	string	currency in the ISO format example: `USD`
`is_amazon_choice`	boolean	"Amazon's choice" label if the value is `true`, the product is marked with the "Amazon's choice" label
`rating`	object	product rating info
`type`	string	type of element = 'rating_element'
`position`	string	the alignment of the element in Amazon SERP possible values: `left`, `right`
`rating_type`	string	the type of rating here you can find the following elements: `Max5`, `Percents`, `CustomMax`
`value`	string	the value of the rating
`votes_count`	integer	the amount of feedback given to a product
`rating_max`	string	the maximum value for a `rating_type`
`is_newer_model_available`	boolean	indicates whether the newer model of the product is available
`is_prime_video`	boolean	indicates whether a product has an Amazon Prime Video label if `true`, specified product is a part of Amazon Prime Video service
`applicable_vouchers`	array	array of objects containing information about applicable vouchers
`type`	string	item type possible values: `amazon_applicable_vouchers_item`
`text`	string	text of the voucher
`fixed_discount`	float	value of the fixed discount
`fixed_discount_currency`	string	currency code of the fixed discount
`percentage_discount`	float	value of the percentage discount if the discount is fixed, the value will be `null`
`important_details`	string	important details about the terms of discount vouchers
`newer_model`	object	information about the newer model of the product
`title`	string	product title
`newer_model_asin`	string	ASIN of the newer product model
`categories`	array	contains related product categories
`category`	string	product category name
`url`	string	product category URL indicates the browse path on Amazon with the unique browse node ID (product category ID on Amazon)
`product_information`	array	contains related product information
`type`	string	type of element = 'product_information_extended_item'
`section_name`	string	name of the section related to product information specified in the `contents`
`contents`	array	contains information specified about the product within the `section_name`
`type`	string	type of element = 'product_information_rows'
`title`	string	title under which related product information appears on the Amazon product page
`rows`	array	rows containing related product information
`type`	string	type of element = 'product_information_text_row'
`text`	string	text specified under the given `title` within the `section_name`
`type`	string	type of element = 'product_information_image_row'
`alt`	string	alternative text of the related product image
`url`	string	URL of the image
`type`	string	type of element = 'product_information_video_row'
`preview`	string	URL of the preview image for the related video
`url`	string	URL of the video
`type`	string	type of element = 'product_information_details_item'
`section_name`	string	name of the section related to product information specified in the `body`
`body`	object	contains information specified about the product within the `section_name`
`product_images_list`	array	contains URLs for all images of the product displayed on the left side of the main image
`product_videos_list`	array	contains URLs for all videos of the product displayed on the right side of the main video
`description`	string	contains description of the product
`is_available`	boolean	indicates whether the product is available for ordering if the value is `true`, the product can be ordered
`top_local_reviews`	array	array of objects with top reviews from target location
`type`	array	type of element = 'amazon_review_item'
`rank_group`	integer	position within a group of elements with identical `type` values positions of elements with different `type` values are omitted from `rank_group`
`rank_absolute`	integer	absolute rank among all the listed reviews absolute position among all reviews on the list
`position`	string	the alignment of the review in SERP can take the following values: `right`
`xpath`	string	the XPath of the element
`verified`	boolean	indicates whether the review has the "Verified Purchase" mark
`subtitle`	string	subtitle of the review
`helpful_votes`	integer	helpful votes count number of users who clicked on the 'Helpful" button under the review text
`images`	array	images of the product submitted by the reviewer
`type`	string	type of element = 'images_element'
`alt`	string	alt tag of the image
`url`	string	relevant url
`image_url`	string	URL of the product image featured in the review
`videos`	array	videos of the product submitted by the reviewer
`type`	string	type of element = 'video_element'
`source`	string	URL to the video source
`preview`	string	URL to the video preview image
`user_profile`	object	user profile of the reviewer
`name`	string
`avatar`	string
`url`	string
`reviews_count`	integer
`locations`	string
`title`	string	title of the review
`url`	string	URL to the review
`review_text`	string	content of the review
`publication_date`	string	date and time when the review was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”; example: `2019-11-15 12:57:46 +00:00`
`rating`	object	the rating score submitted by the reviewer
`rating_type`	string	the type of the rating can take the following values: `Max5`
`value`	float	the value of the rating
`votes_count`	integer	the amount of feedback in this case, the value will be `null`
`rating_max`	integer	the maximum value for a `rating_type` the maximum value for `Max5` is 5
`top_global_reviews`	array	array of objects with top reviews from around the world
`type`	array	type of element = 'amazon_review_item'
`rank_group`	integer	position within a group of elements with identical `type` values positions of elements with different `type` values are omitted from `rank_group`
`rank_absolute`	integer	absolute rank among all the listed reviews absolute position among all reviews on the list
`position`	string	the alignment of the review in SERP can take the following values: `right`
`xpath`	string	the XPath of the element
`verified`	boolean	indicates whether the review has the "Verified Purchase" mark
`subtitle`	string	subtitle of the review
`helpful_votes`	integer	helpful votes count number of users who clicked on the 'Helpful" button under the review text
`images`	array	images of the product submitted by the reviewer
`type`	string	type of element = 'images_element'
`alt`	string	alt tag of the image
`url`	string	relevant url
`image_url`	string	URL of the product image featured in the review
`videos`	array	videos of the product submitted by the reviewer
`type`	string	type of element = 'video_element'
`source`	string	URL to the video source
`preview`	string	URL to the video preview image
`user_profile`	object	user profile of the reviewer
`name`	string
`avatar`	string
`url`	string
`reviews_count`	integer
`locations`	string
`title`	string	title of the review
`url`	string	URL to the review
`review_text`	string	content of the review
`publication_date`	string	date and time when the review was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”; example: `2019-11-15 12:57:46 +00:00`
`rating`	object	the rating score submitted by the reviewer
`rating_type`	string	the type of the rating can take the following values: `Max5`
`value`	float	the value of the rating
`votes_count`	integer	the amount of feedback in this case, the value will be `null`
`rating_max`	integer	the maximum value for a `rating_type` the maximum value for `Max5` is 5

‌‌

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access

# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access 
login="login" 
password="password" 
cred="$(printf ${login}:${password} | base64)" 
curl --location --request POST "https://api.dataforseo.com/v3/merchant/amazon/asin/live/advanced" 
--header "Authorization: Basic ${cred}"  
--header "Content-Type: application/json" 
--data-raw '[
    {
        "language_code": "en_US",
        "location_code": 2840,
        "asin": "B0756FCPPN"
    }
]'

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
try {
    // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
    $client = new RestClient($api_url, null, 'login', 'password');
} catch (RestClientException $e) {
    echo "n";
    print "HTTP code: {$e->getHttpCode()}n";
    print "Error code: {$e->getCode()}n";
    print "Message: {$e->getMessage()}n";
    print  $e->getTraceAsString();
    echo "n";
    exit();
}
$post_array = array();
// You can set only one task at a time
$post_array[] = array(
    "location_name" => "United States",
    "language_name" => "English (United States)",
    "asin" => "B0756FCPPN"
);
try {
    // POST /v3/merchant/amazon/asin/live/advanced
    // in addition to 'amazon' and 'asin' you can also set other search engine and type parameters
    // the full list of possible parameters is available in documentation
    $result = $client->post('/v3/merchant/amazon/asin/live/advanced', $post_array);
    print_r($result);
    // do something with post result
} catch (RestClientException $e) {
    echo "n";
    print "HTTP code: {$e->getHttpCode()}n";
    print "Error code: {$e->getCode()}n";
    print "Message: {$e->getMessage()}n";
    print  $e->getTraceAsString();
    echo "n";
}
$client = null;
?>

const axios = require('axios');

axios({
    method: 'post',
    url: 'https://api.dataforseo.com/v3/merchant/amazon/asin/live/advanced',
    auth: {
        username: 'login',
        password: 'password'
    },
    data: [{
        "asin": "B085RFFC9Q",
        "language_code": "en",
        "asin": "B0756FCPPN"
    }],
    headers: {
        'content-type': 'application/json'
    }
}).then(function (response) {
    var result = response['data']['tasks'];
    // Result data
    console.log(result);
}).catch(function (error) {
    console.log(error);
});

from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# You can set only one task at a time
post_data[len(post_data)] = dict(
    location_name="United States",
    language_name="English (United States)",
    asin="B0756FCPPN"
)
# POST /v3/merchant/amazon/asin/live/advanced
# in addition to 'amazon' and 'asin' you can also set other search engine and type parameters
# the full list of possible parameters is available in documentation
response = client.post("/v3/merchant/amazon/asin/live/advanced", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;

namespace DataForSeoDemos
{
    public static partial class Demos
    {
        public static async Task merchant_amazon_asin_live_advanced()
        {
            var httpClient = new HttpClient
            {
                BaseAddress = new Uri("https://api.dataforseo.com/"),
                // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
                //DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
            };
            var postData = new List<object>();
            // You can set only one task at a time
            postData.Add(new
            {
                language_code = "en",
                location_code = 2840,
                asin = "B0756FCPPN"
            });
            // POST /v3/merchant/amazon/asin/live/advanced
            // in addition to 'amazon' and 'asin' you can also set other search engine and type parameters
            // the full list of possible parameters is available in documentation
            var taskPostResponse = await httpClient.PostAsync("/v3/merchant/amazon/asin/live/advanced", new StringContent(JsonConvert.SerializeObject(postData)));
            var result = JsonConvert.DeserializeObject<dynamic>(await taskPostResponse.Content.ReadAsStringAsync());
            // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
            if (result.status_code == 20000)
            {
                // do something with result
                Console.WriteLine(result);
            }
            else
                Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
        }
    }
}

The above command returns JSON structured like this:

{
  "version": "0.1.20200416",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.0998 sec.",
  "cost": 0.003,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "04171455-0696-0192-0000-4c69cc29b945",
      "status_code": 20100,
      "status_message": "Task Created.",
      "time": "0.0178 sec.",
      "cost": 0.003,
      "result_count": 0,
      "path": [
        "v3",
        "merchant",
        "amazon",
        "asin",
        "task_post"
      ],
      "data": {
        "api": "merchant",
        "function": "asin",
        "se": "amazon",
        "language_code": "en_US",
        "location_code": 2840,
        "asin": "B0756FCPPN",
        "priority": 2,
        "se_type": "shopping",
        "device": "desktop",
        "os": "windows"
      },
      "result": null
    }
  ]
}