/decathlon/products/search

POST /api/decathlon/products/search

Price: 20 credits

Search products on a European Decathlon site by text, with brand, seller, colour, gender, product type, size, sport, characteristic and price filters: each with price, list price, discount, brand, seller, photos, sizes, colours, rating and review count.

How to use it

Find Decathlon products for a text query on one country site, then fetch the full record with decathlon/products. Filter values are the labels shown on that country's site, in its language; a value that matches nothing returns no products. Some common terms open a category page on the site, such as 'rower' on the Polish site: without filters a relevance search for those comes back ordered by rating, and with any filter other than price, or where the site has no search results for them, they fail with 422; browse the category with decathlon/categories/products instead.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string nullable — Decathlon country site; defaults to France (one of: "fr", "de", "it", "es", "pt", "nl", "be_fr", "be_nl", "pl", "gb", "hu", "ch_fr", "ch_de", "ch_it", "cz")
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_ascending", "price_descending", "discount", "rating")
• brands array nullable — Brand names (examples: ["QUECHUA"], ["FORCLAZ","SIMOND"])
• sellers array nullable — Seller names (examples: ["Decathlon"], ["Decathlon","vidaXL"])
• colors array nullable — Colour families (examples: ["noir"], ["black"])
• genders array nullable — Genders (examples: ["HOMME"], ["FEMME","ENFANT"])
• product_types array nullable — Product types (examples: ["sac à dos"], ["tente"])
• sizes array nullable — Sizes (examples: ["M"], ["42","43"])
• attributes object nullable — Product characteristics, keyed by characteristic name (examples: {"volume (en L)":["20 L"]}, {"nombre de personnes":["4 personnes"]})
  • * array
• min_price number nullable — Minimum price (min: 0)
• max_price number nullable — Maximum price (min: 0)
• query string required — Search text (examples: "sac a dos", "tente 4 places"; minLength: 1)
• count integer required — Max number of products to return (min: 1; max: 960)
• sports array nullable — Sports (examples: ["randonnée"], ["running"])

Response

• @type string (default: "DecathlonProductCard")
• id string required
• product_id string nullable
• model_id string nullable
• sku_id string nullable
• name string nullable
• url string nullable
• image string nullable
• images array (default: [])
• brand string nullable
• product_type string nullable
• sports array (default: [])
• seller_name string nullable
• seller_id string nullable
• seller_type string nullable
• price number nullable
• price_without_tax number nullable
• list_price number nullable
• discount_percent number nullable
• recommended_price number nullable
• unit_price number nullable
• currency string nullable
• price_type string nullable
• has_price_range boolean nullable
• is_available_online boolean nullable
• is_sellable_online boolean nullable
• lead_times array (default: [])
• sizes array (default: [])
• colors array (default: [])
• color_count integer nullable
• rating number nullable
• review_count integer nullable
• badges array (default: [])
• product_tags array (default: [])
• is_sponsored boolean nullable

Errors

• 422 — A characteristic name is not offered for this search, or the site answers the term with a category page instead of search results, which filters cannot narrow. 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.