Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
<?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/'; // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard $client = new RestClient($api_url, null, 'login', 'password'); try { $result = array(); // #1 - using this method you can get a list of completed tasks // GET /v3/merchant/amazon/products/tasks_ready $tasks_ready = $client->get('/v3/merchant/amazon/products/tasks_ready'); // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) { foreach ($tasks_ready['tasks'] as $task) { if (isset($task['result'])) { foreach ($task['result'] as $task_ready) { // #2 - using this method you can get results of each completed task // GET /v3/merchant/amazon/products/task_get/advanced/$id if (isset($task_ready['endpoint_advanced'])) { $result[] = $client->get($task_ready['endpoint_advanced']); } // #3 - another way to get the task results by id // GET /v3/merchant/amazon/products/task_get/advanced/$id /* if (isset($task_ready['id'])) { $result[] = $client->get('/v3/merchant/amazon/products/task_get/advanced/' . $task_ready['id']); } */ } } } } print_r($result); // do something with 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; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20200923", "status_code": 20000, "status_message": "Ok.", "time": "0.1189 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "09251555-1535-0209-0000-322f65f6ac84", "status_code": 20000, "status_message": "Ok.", "time": "0.0487 sec.", "cost": 0, "result_count": 1, "path": [ "v3", "merchant", "amazon", "products", "task_get", "advanced", "09251555-1535-0209-0000-322f65f6ac84" ], "data": { "se_type": "organic", "se": "amazon", "api": "merchant", "function": "products", "priority": 2, "language_code": "en_US", "location_code": 2840, "keyword": "gaming keyboard", "device": "desktop", "os": "windows" }, "result": [ { "keyword": "gaming keyboard", "type": "organic", "se_domain": "amazon.com", "location_code": 2840, "language_code": "en_US", "check_url": "https://www.amazon.com/s/?field-keywords=gaming%20keyboard&page=1&language=en_US", "datetime": "2020-09-25 12:55:55 +00:00", "spell": null, "item_types": [ "amazon_paid", "amazon_serp", "editorial_recommendations", "related_searches", "top_rated_from_our_brands" ], "se_results_count": 50544, "categories": [ "PC Gaming Keyboards/All", "Mac Accessories/All", "Mac Accessories/Mac Gaming Keyboards", "GEM Box Microconsole/All", "PlayStation 4 Games, Consoles & Accessories/All", "PlayStation 4 Games, Consoles & Accessories/PlayStation 4 Accessories", "More Categories/Xbox Accessories", "More Categories/Computer Keyboards" ], "items_count": 130, "items": [ { "type": "amazon_paid", "rank_group": 1, "rank_absolute": 1, "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[2]", "domain": "www.amazon.com", "title": "Logitech G915 TKL Tenkeyless Lightspeed Wireless RGB Mechanical Gaming Keyboard, Low Profile Switch Options, LIGHTSYNC RGB, Advanced Wireless and Bluetooth Support - Clicky", "url": "https://www.amazon.com/gp/slredirect/picassoRedirect.html/ref=pa_sp_atf_aps_sr_pg1_1?ie=UTF8&adId=A05670611QUNTPG373XZ0&url=%2FLogitech-Tenkeyless-Lightspeed-Mechanical-LIGHTSYNC%2Fdp%2FB085RFFC9Q%2Fref%3Dsr_1_1_sspa%3Fdchild%3D1%26keywords%3Dgaming%2Bkeyboard%26qid%3D1601038543%26sr%3D8-1-spons%26psc%3D1&qualifier=1601038542&id=4472527830643909&widgetName=sp_atf", "image_url": "https://m.media-amazon.com/images/I/71kr3WAj1FL._AC_UY218_.jpg", "bought_past_month": 200, "price_from": 229.99, "price_to": null, "currency": "USD", "special_offers": [ "Save 69%" ], "data_asin": "B085RFFC9Q", "rating": { "type": "rating_element", "position": "left", "rating_type": "Max5", "value": "4.6", "votes_count": 316, "rating_max": "5" }, "is_amazon_choice": false, "is_best_seller": false, "delivery_info": { "delivery_message": "FREE Shipping by Amazon", "delivery_price": null } }, { "type": "amazon_serp", "rank_group": 1, "rank_absolute": 3, "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[4]", "domain": "www.amazon.com", "title": "Redragon S101 Wired Gaming Keyboard and Mouse Combo RGB Backlit Gaming Keyboard with Multimedia Keys Wrist Rest and Red Backlit Gaming Mouse 3200 DPI for Windows PC Gamers (Black)", "url": "https://www.amazon.com/Redragon-S101-Keyboard-Ergonomic-Programmable/dp/B00NLZUM36/ref=sr_1_3?dchild=1&keywords=gaming+keyboard&qid=1601038543&sr=8-3", "image_url": "https://m.media-amazon.com/images/I/71kr3WAj1FL._AC_UY218_.jpg", "bought_past_month": 100, "price_from": 36.98, "price_to": null, "currency": "USD", "special_offers": null, "data_asin": "B00NLZUM36", "rating": { "type": "rating_element", "position": "left", "rating_type": "Max5", "value": "4.5", "votes_count": 12162, "rating_max": "5" }, "is_amazon_choice": false, "is_best_seller": true, "delivery_info": { "delivery_message": "Get it as soon as Tue, Sep 28 FREE Shipping by Amazon", "delivery_price": null } }, { "type": "editorial_recommendations", "rank_group": 1, "rank_absolute": 5, "position": "left", "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[7]", "items": [ { "type": "amazon_serp_element", "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[7]/div[1]/span[1]/div[1]/div[1]/span[1]/div[1]/div[1]/div[1]/div[1]/div[1]/ol[1]/li[1]", "domain": "www.amazon.com", "title": "NPET K10 Gaming Keyboard USB Wired Floating Keyboard, Quiet Ergonomic Water-Resistant Mechanical Feeling Keyboard, Ultra-Slim Rainbow LED Backlit Keyboard for Desktop, Computer, PC", "url": "https://www.amazon.com/NPET-Floating-Keyboard-Mechanical-Illuminated/dp/B01ALLT2W4/ref=sxin_9_ac_d_pm?ac_md=1-0-VW5kZXIgJDI1-ac_d_pm&cv_ct_cx=gaming+keyboard&dchild=1&keywords=gaming+keyboard&pd_rd_i=B01ALLT2W4&pd_rd_r=5394dc15-8ee7-4f66-bfe1-974f06f024b0&pd_rd_w=3w89s&pd_rd_wg=kcCLl&pf_rd_p=7bce1efb-5229-4289-8758-b64b1d02cfb8&pf_rd_r=A1EMMY83FEN781WGNBY0&psc=1&qid=1601038543&sr=1-1-22d05c05-1231-4126-b7c4-3e7a9c0027d0", "image_url": "https://m.media-amazon.com/images/I/61w0BypBzrL._AC_UL320_.jpg", "bought_past_month": 100, "price_from": 21.99, "price_to": null, "currency": "USD", "special_offers": null, "data_asin": "B01ALLT2W4", "rating": { "type": "rating_element", "position": "left", "rating_type": "Max5", "value": "4.5", "votes_count": 4223, "rating_max": "5" }, "is_amazon_choice": false, "is_best_seller": false, "delivery_info": { "delivery_message": "Fast Delivery To Your Door", "delivery_price": null } }, { "type": "amazon_serp_element", "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[7]/div[1]/span[1]/div[1]/div[1]/span[1]/div[1]/div[1]/div[1]/div[1]/div[1]/ol[1]/li[2]", "domain": "www.amazon.com", "title": "Redragon K552 Mechanical Gaming Keyboard RGB LED Rainbow Backlit Wired Keyboard with Red Switches for Windows Gaming PC (87 Keys, Black)", "url": "https://www.amazon.com/Redragon-K552-Mechanical-Keyboard-Equivalent/dp/B016MAK38U/ref=sxin_9_ac_d_pm?ac_md=2-1-QmV0d2VlbiAkMjUgYW5kICQ1MA%3D%3D-ac_d_pm&cv_ct_cx=gaming+keyboard&dchild=1&keywords=gaming+keyboard&pd_rd_i=B016MAK38U&pd_rd_r=5394dc15-8ee7-4f66-bfe1-974f06f024b0&pd_rd_w=3w89s&pd_rd_wg=kcCLl&pf_rd_p=7bce1efb-5229-4289-8758-b64b1d02cfb8&pf_rd_r=A1EMMY83FEN781WGNBY0&psc=1&qid=1601038543&sr=1-2-22d05c05-1231-4126-b7c4-3e7a9c0027d0", "image_url": "https://m.media-amazon.com/images/I/71cngLX2xuL._AC_UL320_.jpg", "bought_past_month": 100, "price_from": 32.29, "price_to": null, "currency": "USD", "special_offers": null, "data_asin": "B016MAK38U", "rating": { "type": "rating_element", "position": "left", "rating_type": "Max5", "value": "4.4", "votes_count": 9811, "rating_max": "5" }, "is_amazon_choice": false, "is_best_seller": false, "delivery_info": { "delivery_message": "FREE Shipping by Amazon", "delivery_price": null } }, { "type": "amazon_serp_element", "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[7]/div[1]/span[1]/div[1]/div[1]/span[1]/div[1]/div[1]/div[1]/div[1]/div[1]/ol[1]/li[3]", "domain": "www.amazon.com", "title": "Razer Huntsman Gaming Keyboard: Fastest Keyboard Switches Ever - Clicky Optical Switches - Customizable Chroma RGB Lighting - Programmable Macro Functionality - Classic Black", "url": "https://www.amazon.com/Razer-Huntsman-Opto-Mechanical-Board-Durability/dp/B07DHNZ676/ref=sxin_9_ac_d_pm?ac_md=3-2-QmV0d2VlbiAkNTAgYW5kICQxMDA%3D-ac_d_pm&cv_ct_cx=gaming+keyboard&dchild=1&keywords=gaming+keyboard&pd_rd_i=B07DHNZ676&pd_rd_r=5394dc15-8ee7-4f66-bfe1-974f06f024b0&pd_rd_w=3w89s&pd_rd_wg=kcCLl&pf_rd_p=7bce1efb-5229-4289-8758-b64b1d02cfb8&pf_rd_r=A1EMMY83FEN781WGNBY0&psc=1&qid=1601038543&sr=1-3-22d05c05-1231-4126-b7c4-3e7a9c0027d0", "image_url": "https://m.media-amazon.com/images/I/71FJGmeJ2GL._AC_UL320_.jpg", "bought_past_month": 100, "price_from": 89.99, "price_to": null, "currency": "USD", "special_offers": null, "data_asin": "B07DHNZ676", "rating": { "type": "rating_element", "position": "left", "rating_type": "Max5", "value": "4.7", "votes_count": 4780, "rating_max": "5" }, "is_amazon_choice": false, "is_best_seller": false, "delivery_info": { "delivery_message": "FREE Shipping by Amazon", "delivery_price": null } }, { "type": "amazon_serp_element", "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[7]/div[1]/span[1]/div[1]/div[1]/span[1]/div[1]/div[1]/div[1]/div[1]/div[1]/ol[1]/li[4]", "domain": "www.amazon.com", "title": "Razer BlackWidow Elite Mechanical Gaming Keyboard: Green Mechanical Switches - Tactile & Clicky - Chroma RGB Lighting - Magnetic Wrist Rest - Dedicated Media Keys & Dial - USB Passthrough", "url": "https://www.amazon.com/Razer-BlackWidow-Mechanical-Gaming-Keyboard/dp/B07FFCN3DJ/ref=sxin_9_ac_d_pm?ac_md=4-3-QWJvdmUgJDEwMA%3D%3D-ac_d_pm&cv_ct_cx=gaming+keyboard&dchild=1&keywords=gaming+keyboard&pd_rd_i=B07FFCN3DJ&pd_rd_r=5394dc15-8ee7-4f66-bfe1-974f06f024b0&pd_rd_w=3w89s&pd_rd_wg=kcCLl&pf_rd_p=7bce1efb-5229-4289-8758-b64b1d02cfb8&pf_rd_r=A1EMMY83FEN781WGNBY0&psc=1&qid=1601038543&sr=1-4-22d05c05-1231-4126-b7c4-3e7a9c0027d0", "image_url": "https://m.media-amazon.com/images/I/81oLMQUj4fL._AC_UL320_.jpg", "bought_past_month": 100, "price_from": 129.99, "price_to": null, "currency": "USD", "special_offers": null, "data_asin": "B07FFCN3DJ", "rating": { "type": "rating_element", "position": "left", "rating_type": "Max5", "value": "4.7", "votes_count": 3142, "rating_max": "5" }, "is_amazon_choice": false, "is_best_seller": false, "delivery_info": { "delivery_message": "FREE Shipping by Amazon", "delivery_price": null } } ] }, { "type": "related_searches", "rank_group": 1, "rank_absolute": 35, "position": "left", "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[2]/div[1]/span[3]/div[2]/div[26]", "items": [ { "type": "related_searches_element", "title": "gaming mouse", "url": "https://www.amazon.com/s/?k=gaming+mouse&ref=sugsr_0&pd_rd_w=0zUo4&pf_rd_p=0ec05f25-9534-48fe-9c3e-40b89957230e&pf_rd_r=A1EMMY83FEN781WGNBY0&pd_rd_r=8335a81e-e1d6-41b5-865e-fe9a7a29673f&pd_rd_wg=M3xTK&qid=1601038543", "image_alt": "gaming mouse", "image_url": "https://images-na.ssl-images-amazon.com/images/G/01/x-locale/common/grey-pixel.gif" }, { "type": "related_searches_element", "title": "gaming keyboard and mouse", "url": "https://www.amazon.com/s/?k=gaming+keyboard+and+mouse&ref=sugsr_1&pd_rd_w=0zUo4&pf_rd_p=0ec05f25-9534-48fe-9c3e-40b89957230e&pf_rd_r=A1EMMY83FEN781WGNBY0&pd_rd_r=8335a81e-e1d6-41b5-865e-fe9a7a29673f&pd_rd_wg=M3xTK&qid=1601038543", "image_alt": "gaming keyboard and mouse", "image_url": "https://images-na.ssl-images-amazon.com/images/G/01/x-locale/common/grey-pixel.gif" } ] } ] } ] } ] }
Description of the fields for sending a request:
Field name | Type | Description |
---|---|---|
id |
string | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time |
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.
You can also get all available items and possible extra elements by making a request to the following Sandbox URL:
https://sandbox.dataforseo.com/v3/merchant/amazon/products/task_get/advanced/00000000-0000-0000-0000-000000000000
The response will include all available items in the Amazon Products endpoint with the fields containing dummy data.
You won’t be charged for using Sandbox endpoints.
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 |
keyword |
string | keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) |
type |
string | search engine type in a POST array |
se_domain |
string | search engine 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 |
keyword |
string | keyword obtained as a result of search engine autocorrection the results will be provided for the corrected keyword |
type |
string | type of autocorrection possible values: did_you_mean , showing_results_for , no_results_found_for , including_results_for |
item_types |
array | types of search results found in Amazon SERP contains types of all search results ( items ) found in the returned SERPpossible item types: amazon_serp , amazon_paid , editorial_recommendations , top_rated_from_our_brands , related_searches |
se_results_count |
integer | search engine results count |
categories |
array | amazon product departments and subcategories |
items_count |
integer | the number of results returned in the items array |
items |
array | Amazon product items |
‘editorial_recommendations’ element | ||
type |
string | type of item = ‘editorial_recommendations’ |
rank_group |
integer | position within a group of elements with identical type valuespositions 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 SERP |
position |
string | the alignment of the element in Amazon SERP possible values: left , right |
xpath |
string | the XPath of the element |
items |
array | Amazon product items within the editorial_recommendations element |
type |
string | type of element = ‘amazon_serp_element’ |
xpath |
string | the XPath of the element |
domain |
string | Amazon domain |
title |
string | product title |
url |
string | the URL of the product page |
image_url |
string | URL of the product image featured in the results |
bought_past_month |
integer | number of product purchases in the past month |
price_from |
float | the regular price of a product example: 49.98 |
price_to |
float | the upper limit of the product price range example: 384.99 |
currency |
string | currency in the ISO format example: USD |
special_offers |
array | special offer details contains special offer details, including coupon and Subscribe & Save discounts |
data_asin |
string | unique product identifier on Amazon note that there is no full list of possible values as the data_asin is a dynamic value assigned by Amazonexample: B07G82D89J |
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_amazon_choice |
boolean | “Amazon’s choice” label if the value is true , the product is marked with the “Amazon’s choice” label |
is_best_seller |
boolean | “Best Seller” label if the value is true , the product is marked with the “Best Seller” label |
delivery_info |
object | delivery information delivery information including free and fast delivery date ranges |
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 delivery price is a range |
displayed_price |
string | price line provided as displayed in Amazon listing |
‘amazon_serp’ element | ||
type |
string | type of element = ‘amazon_serp’ |
rank_group |
integer | position within a group of elements with identical type valuespositions 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 SERP |
xpath |
string | the XPath of the element |
domain |
string | Amazon domain |
title |
string | product title |
url |
string | the URL of the product page |
image_url |
string | URL of the product image featured in the results |
bought_past_month |
integer | number of product purchases in the past month |
price_from |
float | the regular price of a product example: 49.98 |
price_to |
float | the upper limit of the product price range example: 384.99 |
currency |
string | currency in the ISO format example: USD |
special_offers |
array | special offer details contains special offer details, including coupon and Subscribe & Save discounts |
data_asin |
string | unique product identifier on Amazon note that there is no full list of possible values as the data_asin is a dynamic value assigned by Amazonexample: B07G82D89J |
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_amazon_choice |
boolean | “Amazon’s choice” label if the value is true , the product is marked with the “Amazon’s choice” label |
is_best_seller |
boolean | “Best Seller” label if the value is true , the product is marked with the “Best Seller” label |
delivery_info |
object | delivery information delivery information including free and fast delivery date ranges |
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 delivery price is a range |
displayed_price |
string | price line provided as displayed in Amazon listing |
‘amazon_paid’ element | ||
type |
string | type of element = ‘amazon_paid’ |
rank_group |
integer | position within a group of elements with identical type valuespositions 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 SERP |
xpath |
string | the XPath of the element |
domain |
string | Amazon domain |
title |
string | product title |
url |
string | the URL of the product page |
image_url |
string | URL of the product image featured in the results |
bought_past_month |
integer | number of product purchases in the past month |
price_from |
float | the regular price of a product example: 49.98 |
price_to |
float | the upper limit of the product price range example: 384.99 |
currency |
string | currency in the ISO format example: USD |
special_offers |
array | special offer details contains special offer details, including coupon and Subscribe & Save discounts |
data_asin |
string | unique product identifier on Amazon note that there is no full list of possible values as the data_asin is a dynamic value assigned by Amazonexample: B07G82D89J |
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_amazon_choice |
boolean | “Amazon’s choice” label if the value is true , the product is marked with the “Amazon’s choice” label |
is_best_seller |
boolean | “Best Seller” label if the value is true , the product is marked with the “Best Seller” label |
delivery_info |
object | delivery information delivery information including free and fast delivery date ranges |
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 delivery price is a range |
displayed_price |
string | price line provided as displayed in Amazon listing |
‘top_rated_from_our_brands’ element | ||
type |
string | type of element = ‘top_rated_from_our_brands’ |
rank_group |
integer | position within a group of elements with identical type valuespositions 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 SERP |
xpath |
string | the XPath of the element |
items |
array | contains Amazon product items featured in the “Top rated from our brands” section product items of this section are from Amazon’s private-label brands and can only be found on Amazon’s site possible item types: "amazon_serp_element “ |
type |
string | type of element = ‘amazon_serp_element’ |
xpath |
string | the XPath of the element |
domain |
string | Amazon domain |
title |
string | product title |
url |
string | the URL of the product page |
image_url |
string | URL of the product image featured in the results |
bought_past_month |
integer | number of product purchases in the past month |
price_from |
float | the regular price of a product example: 49.98 |
price_to |
float | the upper limit of the product price range example: 384.99 |
currency |
string | currency in the ISO format example: USD |
special_offers |
array | special offer details contains special offer details, including coupon and Subscribe & Save discounts |
data_asin |
string | unique product identifier on Amazon note that there is no full list of possible values as the data_asin is a dynamic value assigned by Amazonexample: B07G82D89J |
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_amazon_choice |
boolean | “Amazon’s choice” label if the value is true , the product is marked with the “Amazon’s choice” label |
is_best_seller |
boolean | “Best Seller” label if the value is true , the product is marked with the “Best Seller” label |
delivery_info |
object | delivery information delivery information including free and fast delivery date ranges |
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 delivery price is a range |
displayed_price |
string | price line provided as displayed in Amazon listing |
‘related_searches’ element | ||
type |
string | type of element = ‘related_searches’ |
rank_group |
integer | position within a group of elements with identical type valuespositions 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 SERP |
xpath |
string | the XPath of the element |
items |
array | contains |
type |
string | type of element = ‘related_searches_element’ |
title |
string | product title |
url |
string | the URL of the product page |
image_alt |
string | the alt tag of the product image featured in the results |
image_url |
string | URL of the product image featured in the results |