/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

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 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.
no product matchingFor the given value we do not have a product matching yet. For a detailed description see: Product Matching.
Job creation limit exceededYou have exceeded the allowed number of job creations per minute. Please wait a moment before trying again.

Further error codes may be added.

Body Params
string
required

Your API key

string
required
Defaults to google_shopping

Name of the data source to request from

string
required
Defaults to us

Lower case alpha-2 country code of the source to request from (like us, gb, de, ...)

string
required
Defaults to search_results

What type of content to collect. Different topics exist per source. (Like search_results, offers, product, ...

string
required
Defaults to term

The type of identifier you want to use. Different keys exist per topic. (id, term, gtin)

string
required
Defaults to apple iphone 6S 64GB gold

The identifiers you want to request, separated by newline characters

string
Defaults to 3

Prices may be paginated. How many pages do you want to request? Integer; default is 1.

string
Defaults to 1440

How current should the data be? Give a maximum number of minutes. Integer; different defaults for each topic

string
Defaults to 100

Number of minutes after which to stop collecting data and finishing the job. Integer; default is 1,440 minutes (24 hours).

string

Webhook Url will be requested once the job finishes

string
enum

HTTP method for initializing the webhook_url; default is POST

Allowed:
string
enum

Defines the format of the Job result which is being generated; default format is json; not all topics support these download formats, more details can be found in the dedicated Webhooks article

Allowed:
Responses

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