/jobs

Step 1: Create a new job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Size limit

We limit the number of items that can be requested in a single job to 1,000. If you want to request more than 1,000 products, you can run multiple jobs in parallel.

JSON response

The only relevant information in the JSON response is the job_id. Save this value for steps 2 and 3.

Errors

An error is indicated by an HTTP status code in the 4xx and 5xx ranges. If the error happens on an application level, we try to provide an explanation in JSON.

🚧

Non-JSON responses

If something goes wrong somewhere deeper in our stack (say on a load balancer), we might return a different kind of response (like HTML or text).

Example error response

{
  "success": false,
  "reason": "unauthorized",
  "parameter": "token",
  "comment": "Provide your API key with the parameter 'token'!"
}
<html><body><h1>503 Service Unavailable</h1>
No server is available to handle this request.
</body></html>

List of error codes

Error codeMeaning
unauthorizedNo token given or token is not valid.
missing parameterNot all required parameters were given.
parameter value invalidGiven value is not allowed for this parameter.
unknown sourceChosen source is not supported (yet).
unsupported countryChosen country is not supported for the chosen source.
unsupported keyChosen key is not supported by the chosen source.
source disabledCombination of source and country is temporarily disabled.
key disabledChosen key is temporarily disabled for this source and country.
value disabledChosen value is temporarily disabled for this source, country and key.
not enough free creditsNot enough free credits left for the given request, a paid subscription is needed.
daily quota exceededUser-defined daily quota is exceeded. You can change this. See Daily quota.
too many valuesRequested more than 1,000 values in one job.
completeness not allowedBased on your plan, you are not allowed to use the requested completeness setting.
condition not allowedBased on your plan, you are not allowed to use the requested conditionsetting.

Further error codes may be added.

Body Params
string
required

Your API key

string
required
Defaults to E.g. google-shopping or amazon

Name of the data source to request from

string
required
Defaults to E.g. us, gb, de, ...

Lower case alpha-2 country code of the source to request from

string
required
Defaults to source_id, gtin or keyword

The type of identifier you want to use (source_id, gtin, keyword)

string
required
Defaults to E.g. iPhone 6S for key=keyword

The identifiers you want to request, separated by newline characters

string
Defaults to Defaults to one_page

Prices may be paginated. How many pages do you want to request? (one_page, all_pages)

string
Defaults to Defaults to daily_updated

How current should the data be? (daily_updated, realtime)

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json