/zalando/products/related

POST /api/zalando/products/related

Price: 10 credits

Get Zalando product recommendations by product URL: cross-sell items that go with this product, more from the same brand, similar styles and sponsored cards. Each card has id, brand, name, price, image and product URL.

How to use it

Fetch related/recommended Zalando products for a product URL (a page address ending in -{config-sku}.html). Returns a flat list of recommendation cards, each with id (config-sku), url, reason (cross_sell = goes with this product, same_brand = more from the same brand, similar = similar styles, sponsored), name, brand+brand_alias, price/list_price/discount_percentage/currency (EUR), image, is_in_stock, gender and is_sponsored.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Zalando product URL (a canonical product page address ending in -{config-sku}.html) (examples: "https://www.zalando.de/nike-sportswear-court-borough-recraft-unisex-sneaker-low-white-ni116d0lr-a15.html"; minLength: 1)
• count integer required — Max number of related products to return (min: 1)

Response

• @type string (default: "ZalandoRelatedProduct")
• id string required
• url string required
• reason string required (one of: "cross_sell", "same_brand", "similar", "sponsored")
• name string nullable
• brand string nullable
• brand_alias string nullable
• price number nullable
• list_price number nullable
• discount_percentage number nullable
• currency string nullable
• image string nullable
• is_in_stock boolean 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 — Product not found, or the product page exposes no recommendations 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.