/idealo/products

POST /api/idealo/products

Price: 20 credits

Get an Idealo product by product id (or product URL) on a chosen national Idealo site: name, brand, GTIN, the category path with ids, the lowest and highest offer price, the lowest price including shipping, the number of offers, the average user rating and rating count, online availability, energy class, the product page URL and images, and the price per reference unit for goods sold by volume, weight or length.

How to use it

Use for one Idealo product's catalogue data and price summary on one national site; the id comes from idealo/products/search. Category names are in that site's language and prices in its currency. Price fields are null and offer_count is 0 when no shop currently offers the product, which is still a 200. For each shop's own offer use idealo/products/offers.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Idealo product id or a product URL containing it (examples: "204374464", "https://www.idealo.de/preisvergleich/OffersOfProduct/204374464_-portasplit-3-5-kw-midea.html"; minLength: 1)
• country string — National Idealo site to read the product from. The product itself is the same across sites, but its price, availability, currency, page URL and the language of the category names are per site, and a product listed in one country may be absent in another (default: "de"; one of: "de", "at", "gb", "fr", "it", "es")

Response

• @type string (default: "IdealoProduct")
• id string required
• site_id string required
• country string required
• currency string required
• name string nullable
• variant_group_id string nullable — Id of the variant group (colours, sizes, pack sizes) this product belongs to, when it is one variant of a group
• url string nullable
• brand string nullable
• gtin string nullable
• category string nullable
• category_id string nullable
• main_category string nullable
• breadcrumbs array (default: [])
  • @type string (default: "IdealoProductCategory")
  • id string nullable
  • name string required
• price number nullable
• total_price number nullable
• highest_price number nullable
• offer_count integer nullable
• rating number nullable — Average user rating on a 1-5 scale
• review_count integer nullable
• is_available_online boolean nullable
• is_main_product boolean nullable — Only on products that belong to a variant group (colours, sizes, pack sizes): true for the variant Idealo presents as the group's main product. Null on products without variants
• energy_class string nullable
• image string nullable
• thumbnail string nullable
• images array (default: [])
• base_price object nullable
  • @type string (default: "IdealoProductBasePrice")
  • amount number nullable
  • unit string nullable
  • price number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Product not found (well-formed id that this national Idealo site does not list) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.