/decathlon_us/products/search

POST /api/decathlon_us/products/search

Price: 20 credits

Search Decathlon US products by text, brand, product type, colour, size, price and stock: each with price, list price, brand, description, options, photos and Decathlon model code.

How to use it

Find Decathlon US products for a text query, then fetch variant stock, features and specifications with decathlon_us/products. Brand, product type, colour and size take the labels shown on decathlon.com; a label that matches nothing returns no products. Prices are in USD.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• brands array nullable — Brand names (examples: ["Quechua"], ["Forclaz","Simond"])
• product_types array nullable — Product types (examples: ["Tent"], ["Down jacket","Fleece"])
• colors array nullable — Colors (examples: ["Black"], ["Blue","Green"])
• sizes array nullable — Variant sizes (examples: ["M"], ["S","M"])
• min_price number nullable — Minimum price in USD (min: 0)
• max_price number nullable — Maximum price in USD (min: 0)
• only_available boolean — Only products in stock (default: false)
• query string required — Search text (examples: "tent", "trail running shoes"; minLength: 1)
• count integer required — Max number of products to return (min: 1; max: 1000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_low_to_high", "price_high_to_low")

Response

• @type string (default: "DecathlonUsProductCard")
• id string required
• alias string nullable
• url string nullable
• description string nullable
• brand string nullable
• product_type string nullable
• model_code string nullable
• price number nullable
• max_price number nullable
• list_price number nullable
• currency string nullable
• is_available boolean nullable
• image string nullable
• images array (default: [])
• tags array (default: [])
• attributes array (default: [])
  • @type string (default: "DecathlonUsAttribute")
  • name string required
  • value string required
• options array (default: [])
  • @type string (default: "DecathlonUsOption")
  • name string required
  • values array (default: [])
• created_at integer nullable
• updated_at integer nullable
• published_at integer 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 — 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.