/idealo/products/offers

POST /api/idealo/products/offers

Price: 10 credits

List the shop offers Idealo compares for one product on a chosen national Idealo site: the shop name, id, logo, its Idealo shop rating and how many shop reviews that rests on, the offer's own product title, the price and the price including that shop's shipping with their currency, the stated delivery window and carrier, the accepted payment methods, whether the offer is a marketplace listing, and the link through to the shop.

How to use it

Use this rather than `idealo/products` whenever the question is who sells it and for how much: `idealo/products` returns only the single cheapest price, while this returns one row per shop. Compare on `total_price`, not `price` — `price` excludes shipping, and the cheapest `price` is often not the cheapest delivered, which is exactly what Idealo's own list flags. `total_price` and `delivery` are absent on some rows because the shop does not publish them, not because they are free or immediate. `shop_rating` is out of 5 and is about the shop, not the product. Real lists are short — most products have a few dozen offers and the whole list is returned well before a large `count` is reached. Offers are ordered as Idealo ranks them, which is not strictly by price. `X-Total-Available-Results` states how many offers are reachable for the product, so a body shorter than that with an `X-Results-Truncated` header is an incomplete answer worth repeating, while one without it is the whole list.

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: "204743522", "https://www.idealo.de/preisvergleich/OffersOfProduct/204374464_-portasplit-3-5-kw-midea.html"; minLength: 1)
• country string — National Idealo site whose shops to list. Each site carries its own shops, prices and currency (default: "de"; one of: "de", "at", "gb", "fr", "it", "es")
• count integer required — Max number of shop offers to return (examples: 20, 50; min: 1; max: 200)

Response

• @type string (default: "IdealoOffer")
• offer_key string required
• product_id string required
• shop_id string nullable
• shop_name string nullable
• shop_image string nullable
• shop_rating number nullable — Shop rating on a 1-5 scale, as Idealo's own shop reviews report it
• shop_review_count integer nullable
• offer_title string nullable — Product title as this shop words it, which often differs from the Idealo name
• price number nullable
• total_price number nullable — Price including this shop's shipping cost for the product
• currency string required
• delivery string nullable — Delivery window as the shop states it, in that site's language
• delivery_status string nullable — Delivery speed bucket Idealo assigns this offer: SHORT, MEDIUM, LONG, or OUT where the shop lists it as unavailable
• delivery_providers array (default: [])
• payment_methods array (default: [])
• is_marketplace boolean (default: false)
• marketplace_merchant string nullable — On a marketplace offer, the merchant actually selling through the shop, which is not the shop the rating belongs to
• url string 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 — No such product on this national Idealo site, or it currently has no offers there 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.