Basic workflow

Requesting data via Price API is a three-step process:

1. You create a job.
2. You wait for the job to finish collecting data.
3. You download the job's results.

1. Create a job

A job encapsulates your request to collect one or more products (or other kind of data). It specifies:

• The source from which to collect the data (e.g. Amazon or Google Shopping)
• The country in which to collect the data (e.g. the United States, Great Britain or Germany)
• The key by which to search (e.g. search by GTIN, EAN, UPC or keyword)
• The values for which to search (e.g. 5901234123457 or "iPhone 6s blue")
• The currentness, indicating if you need very fresh data or accept data that has been cached (for a discount)
• The completeness, indicating how many offers you want per product (e.g. just the cheapest 10 offers or all offers)

When you create a job, you are given an ID (job_id) that you need to refer to the job in the next steps.

📘

See API reference

POST /jobs

2. Wait for the job to finish

Now you poll the job's status every minute. A progress will be shown for your information, but the important part of the response is its status which needs to be finished (not working or finishing) before you can download the results.

📘

See API reference

GET /jobs/:job_id

3. Download the job's results

When the job's status is finished (and only then) can you download its results.

Results can be downloaded in four different formats:

• JSON (recommended for integration)
• XML
• CSV rows (recommended for use in Excel pivot tables)
• CSV columns

🚧

72 hour retention period

Job results are only available for 72 hours after the job was requested. After that we permanently delete the results. So please make sure to download the results shortly after the job finishes.

📘

See API reference

GET /products/bulk/:job_id