Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
<?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-access $client = new RestClient($api_url, null, 'login', 'password'); try { // using this method you can get a list of locations // GET /v3/merchant/amazon/locations $result = $client->get('/v3/merchant/amazon/locations'); 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.20200421", "status_code": 20000, "status_message": "Ok.", "time": "0.2710 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "04211125-1535-0207-0000-e59a45a4418b", "status_code": 20000, "status_message": "Ok.", "time": "0.1615 sec.", "cost": 0, "result_count": 31829, "path": [ "v3", "merchant", "amazon", "locations" ], "data": { "api": "merchant", "function": "locations", "se": "amazon" }, "result": [ { "location_code": 2840, "location_name": "United States", "location_name_parent": null, "country_iso_code": "US", "location_type": "Country" }, { "location_code": 9001634, "location_name": "01001,Massachusetts,United States", "location_name_parent": "Massachusetts,United States", "country_iso_code": "US", "location_type": "Postal Code" }, { "location_code": 2826, "location_name": "United Kingdom", "location_name_parent": null, "country_iso_code": "GB", "location_type": "Country" }, { "location_code": 9044854, "location_name": "NR29,England,United Kingdom", "location_name_parent": "England,United Kingdom", "country_iso_code": "GB", "location_type": "Postal Code" }, { "location_code": 2250, "location_name": "France", "location_name_parent": null, "country_iso_code": "FR", "location_type": "Country" }, { "location_code": 9054893, "location_name": "01000,Auvergne-Rhone-Alpes,France", "location_name_parent": "Auvergne-Rhone-Alpes,France", "country_iso_code": "FR", "location_type": "Postal Code" } ] } ] }
You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
You can also download the full list of supported locations in the CSV format (last updated 2024-10-14).
Description of the fields for setting a task:
Field name | Type | Description |
---|---|---|
country |
string | country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us |
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.
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 |
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 returned with 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 parameters passed in the URL of the GET request |
result |
array | array of results |
location_code |
integer | location code |
location_name |
string | full name of the location |
location_name_parent |
string | the name of the superordinate location example: "location_code": 9041134, |
country_iso_code |
string | ISO country code of the location |
location_type |
string | location type |