/leroymerlin/products/search

POST /api/leroymerlin/products/search

Price: 20 credits

Search Leroy Merlin Italy or Spain products by text with sorting and the site's filters, returning price, discount, seller, rating and delivery options

How to use it

Search one Leroy Merlin country site in its own language, so pass Italian text for it and Spanish text for es. Filter names and options are the ones on that site's results page and depend on the query; an unknown one is rejected with the available choices. A query matching one product reference returns that product alone.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string required — Leroy Merlin country site (one of: "it", "es")
• count integer required — Max number of products to return (min: 1; max: 450)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc")
• filters array nullable — Filters from the results sidebar, one option per filter; different filters combine (examples: [{"facet":"Marca","value":"BOSCH"},{"facet":"Voltaggio (in V)","value":"18"}], [{"facet":"Venduto da Leroy Merlin","value":"true"}], [{"facet":"Prezzo","value":"50-100"}])
  • facet string required — Filter name as shown on the site (examples: "Marca"; minLength: 1)
  • value string required — Option as shown on the site, or the bounds of a range filter such as the price (examples: "BOSCH", "50-100"; minLength: 1)
• query string required — Search text (examples: "trapano", "taladro"; minLength: 1)

Response

• @type string (default: "LeroyMerlinListingProduct")
• id string required
• name string nullable
• url string nullable
• brand string nullable
• image string nullable
• rating number nullable
• review_count integer nullable
• price number nullable
• price_excluding_vat number nullable
• original_price number nullable
• discount_amount number nullable
• discount_percent number nullable
• currency string nullable
• seller_id string nullable
• seller_name string nullable
• seller_type string nullable
• sellers_composition string nullable
• offer_count integer nullable
• offer_type string nullable
• reconditioned_state string nullable
• marketing_tag string nullable
• is_sponsored boolean nullable
• is_available_to_buy boolean nullable
• delivery_options array (default: [])

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 — The entity was not found, or a precondition failed 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.