Step 1: Create a new job.


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

JSON response contains job information along with job_id, we will need it for step 2 and 3.


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.

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.
invalid valueGiven value is not valid for the chosen key.

Further error codes may be added.

Click Try It! to start a request and see the response here!