/zalando/products/search

POST /api/zalando/products/search

Price: 10 credits

Search Zalando products by keyword. Returns id (config-sku), url, name, brand, color, price, list_price, discount, 30-day lowest price, image, gender and whether the card is a sponsored placement. Supports optional brand, size, colour, price-range and sort filters.

How to use it

Search Zalando products by keyword. Each result has id (config-sku), url (feed to zalando/products for full detail), name, brand, color, price/list_price/discount_percentage/currency (EUR), lowest_price_30d (the EU 30-day lowest prior price), image, gender and is_sponsored. Narrow results with the optional brand (brand slug), size, color, min_price/max_price (EUR) and sort fields.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "sneaker", "red dress", "leather jacket"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• brand string nullable — Restrict results to a single brand (Zalando brand slug, e.g. nike, adidas-originals).
• size string nullable — Restrict results to a size (e.g. M, 42, XL).
• color string nullable — Restrict results to a colour (e.g. red, black, blue).
• min_price number nullable — Minimum price in EUR. (>: 0)
• max_price number nullable — Maximum price in EUR. (>: 0)
• sort string — Result ordering. (default: "popularity"; one of: "popularity", "activation_date", "price_asc", "price_desc", "sale")

Response

• @type string (default: "ZalandoSearchProduct")
• id string required
• url string required
• name string nullable
• brand string nullable
• color string nullable
• price number nullable
• list_price number nullable
• discount_percentage number nullable
• currency string nullable
• lowest_price_30d number nullable
• image string nullable
• gender string nullable
• is_sponsored boolean (default: false)

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.