📘
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.

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>

{
  "success": false,
  "reason": "Job creation limit exceeded",
  "comment": "You can create up to X jobs per minute."
}

List of error codes

Error code	Meaning
`unauthorized`	No `token` given or `token` is not valid.
`missing parameter`	Not all required parameters were given.
`parameter value invalid`	Given `value` is not allowed for this parameter.
`unknown source`	Chosen `source` is not supported (yet).
`unsupported country`	Chosen `country` is not supported for the chosen `source`.
`unsupported key`	Chosen `key` is not supported by the chosen `source`.
`source disabled`	Combination of `source` and `country` is temporarily disabled.
`key disabled`	Chosen `key` is temporarily disabled for this `source` and `country`.
`value disabled`	Chosen `value` is temporarily disabled for this `source`, `country` and `key`.
`not enough free credits`	Not enough free credits left for the given request, a paid subscription is needed.
`daily quota exceeded`	User-defined daily quota is exceeded. You can change this. See Daily quota.
`too many values`	Requested more than 1,000 `values` in one job.
`invalid value`	Given `value` is not valid for the chosen `key`.
`no product matching`	For the given `value` we do not have a product matching yet. For a detailed description see: Product Matching.
`Job creation limit exceeded`	You have exceeded the allowed number of job creations per minute. Please wait a moment before trying again.

Further error codes may be added.