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
learn more about ASINs in this help center guide |
type |
string |
search engine type
possible values: sellers_list |
se_domain |
string |
search engine domain received in a POST array |
location_code |
integer |
location code received in a POST array |
language_code |
string |
language code received in a POST array |
check_url |
string |
direct URL to Amazon results
you can use it to make sure the provided results are accurate |
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 |
title |
string |
product title
title of the product relevant to the asin received in a POST array |
image |
string |
product image url
image URL of the product relevant to the asin received in a POST array |
item_types |
array |
types of search results found in Amazon Sellers SERP
contains types of all search results (items) found in the returned SERP
possible item types:
amazon_seller_main_item, amazon_seller_item |
items_count |
integer |
the number of results returned in the items array |
items |
array |
items in SERP |
| ‘amazon_seller_main_item’ |
|
|
type |
string |
type of item = ‘amazon_seller_main_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 in SERP
absolute position among all the elements found in Amazon Sellers SERP |
position |
string |
alignment of the element in SERP
possible values:
left, right |
xpath |
string |
XPath of the element |
seller_name |
string |
business name of the seller |
seller_url |
string |
url forwarding to the seller’s page on Amazon
|
ships_from |
string |
sender company name
|
price |
object |
product pricing details
if there are no details, the value will be null |
current |
float |
current product price with discount |
regular |
float |
regular product price without discount |
max_value |
float |
maximal displayed price of the product |
currency |
string |
currency in the ISO format
example:
USD |
is_price_range |
boolean |
price is displayed as a range
indicates whether the price is displayed as a range |
displayed_price |
string |
price as displayed in SERP
price line provided as displayed in Amazon listing |
percentage_discount |
float |
value of the percentage discount
|
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
|
rating |
object |
seller rating details
seller popularity rate based on customer reviews |
type |
string |
type of element = ‘rating_element’ |
rating_type |
string |
the type of rating
here you can find the following elements: Max5 |
value |
string |
the value of the rating |
votes_count |
integer |
the amount of feedback |
rating_max |
integer |
the maximum value for a rating_type |
condition |
string |
product condition
condition of the product offered by the seller |
condition_description |
string |
product condition details
expanded details on the condition of the product offered by the seller |
delivery_info |
object |
delivery information
delivery information including free and fast delivery date ranges |
delivery_date_from |
string |
earliest delivery date
the earliest date when the product can be shipped |
delivery_date_to |
string |
latest delivery date
the latest date when the product can be delivered |
fastest_delivery_date_from |
string |
earliest free delivery date
the earliest date when the product can be delivered with a fast delivery option |
fastest_delivery_date_to |
string |
latest free delivery date
the latest date when the product can be delivered with a fast delivery option |
delivery_message |
string |
delivery information
message accompanying the delivery information as posted by the seller |
delivery_price |
object |
price for the delivery
price of the delivery based on the location you specified in the POST request;
if free delivery is available, the value is null |
current |
float |
current delivery price
|
regular |
float |
regular undiscounted delivery price
|
max_value |
float |
maximum undiscounted delivery price
|
currency |
string |
currency in the ISO format
|
is_price_range |
boolean |
indicates whether the delivary price is a range
|
displayed_price |
string |
price line provided as displayed in Amazon listing
|
| ‘amazon_seller_item’ |
|
|
type |
string |
type of item = ‘amazon_seller_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 in SERP
absolute position among all the elements found in Amazon Sellers SERP |
position |
string |
alignment of the element in SERP
can take the following values:
left, right |
xpath |
string |
XPath of the element |
seller_name |
string |
business name of the seller |
seller_url |
string |
url forwarding to the seller’s page on Amazon
|
ships_from |
string |
sender company name
|
price |
object |
product pricing details
if there are no details, the value will be null |
current |
float |
current product price with discount |
regular |
float |
regular product price without discount |
max_value |
float |
maximal displayed price of the product |
currency |
string |
currency in the ISO format
example:
USD |
is_price_range |
boolean |
price is displayed as a range
indicates whether the price is displayed as a range |
displayed_price |
string |
price as displayed in SERP
price line provided as displayed in Amazon listing |
percentage_discount |
float |
value of the percentage discount
|
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
|
rating |
object |
seller rating details
seller popularity rate based on customer reviews |
type |
string |
type of element = ‘rating_element’ |
rating_type |
string |
the type of rating
here you can find the following elements: Max5 |
value |
string |
the value of the rating |
votes_count |
integer |
the amount of feedback |
rating_max |
integer |
the maximum value for a rating_type |
condition |
string |
product condition
condition of the product offered by the seller |
condition_description |
string |
product condition details
expanded details on the condition of the product offered by the seller |
delivery_info |
object |
delivery information
delivery information including free and fast delivery date ranges |
delivery_date_from |
string |
earliest delivery date
the earliest date when the product can be shipped |
delivery_date_to |
string |
latest delivery date
the latest date when the product can be delivered |
fastest_delivery_date_from |
string |
earliest free delivery date
the earliest date when the product can be delivered with a fast delivery option |
fastest_delivery_date_to |
string |
latest free delivery date
the latest date when the product can be delivered with a fast delivery option |
delivery_message |
string |
delivery information
message accompanying the delivery information as posted by the seller |
delivery_price |
object |
price for the delivery
price of the delivery based on the location you specified in the POST request;
if free delivery is available, the value is null |
current |
float |
current delivery price
|
regular |
float |
regular undiscounted delivery price
|
max_value |
float |
maximum undiscounted delivery price
|
currency |
string |
currency in the ISO format
|
is_price_range |
boolean |
indicates whether the delivary price is a range
|
displayed_price |
string |
price line provided as displayed in Amazon listing
|