/netaporter/products/related

POST /api/netaporter/products/related

Price: 10 credits

Get the products Net-a-Porter recommends for a product: similar items you may also like and the outfit pieces it is styled with

How to use it

Takes a product URL or a color id as returned by the Net-a-Porter search and category endpoints. relation tells which list a row came from; wear_it_with rows carry their outfit_id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of products to return (min: 1)
• product string required — Net-a-Porter product id or product page URL (examples: "https://www.net-a-porter.com/en-us/shop/product/destree/clothing/midi-dresses/celia-floral-jacquard-taffeta-midi-dress/46376663163136775", "46376663163136775"; minLength: 1)
• relations array — Recommendation lists to return (default: ["you_may_also_like","wear_it_with"]; one of: "you_may_also_like", "wear_it_with"; minItems: 1)
• region string — Store region; it sets the assortment and the currency (default: "us"; one of: "us", "ca")

Response

• @type string (default: "NetaporterRelatedProduct")
• id string required
• catalog_id string nullable
• model_id string nullable
• manufacturer_code string nullable
• name string nullable
• name_en string nullable
• designer string nullable
• designer_id string nullable
• url string nullable
• price object nullable
  • @type string (default: "NetaporterPrice")
  • currency string nullable
  • currency_symbol string nullable
  • price number nullable
  • original_price number nullable
  • discount_percent number nullable
  • price_rounded number nullable
  • original_price_rounded number nullable
  • is_from_price boolean nullable
• color string nullable
• color_code string nullable
• legacy_id string nullable
• is_buyable boolean nullable
• is_visible boolean nullable
• is_displayable boolean nullable
• is_on_sale boolean nullable
• is_final_sale boolean nullable
• is_promo boolean nullable
• is_not_stocked_online boolean nullable
• has_other_colors boolean nullable
• image string nullable
• images array (default: [])
• badges array (default: [])
  • @type string (default: "NetaporterBadge-Output")
  • code string required
  • label string nullable
  • badge_type string nullable
• categories array (default: [])
  • @type string (default: "NetaporterCategoryRef")
  • id string required
  • code string nullable
  • name string nullable
  • path string nullable
• attributes array (default: [])
  • @type string (default: "NetaporterAttribute")
  • name string required
  • values array (default: [])
• relation string required
• outfit_id string 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 — No Net-a-Porter product has this id 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.