/farfetch/products/search

POST /api/farfetch/products/search

Price: 20 credits

Search full-price Farfetch products by keywords in one market and department, filtered by brand, category, color, letter size, price range and fast delivery

How to use it

Keyword search over full-price Farfetch items; sale items are reached through the Farfetch brand products endpoint with sale set. Prices follow market.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• market string — Farfetch market; it sets the assortment and the currency (default: "uk"; one of: "uk", "de", "fr", "it", "es", "nl", "ie", "at", "pl", "au", "nz", "ca", "cn", "hk", "mo", "tw", "jp", "kr", "sg", "ae", "il")
• gender string — Store department (default: "women"; one of: "women", "men", "kids")
• colors array nullable — Colors (one of: "black", "white", "grey", "neutrals", "brown", "green", "blue", "red", "pink", "yellow", "metallic", "multicolour", "gold", "silver", "purple", "orange")
• sizes array nullable — Letter sizes (one of: "OS", "XXXS", "XXS", "XS", "S", "M", "L", "XL", "XXL", "3XL", "4XL", "5XL", "7XL")
• category_ids array nullable — Farfetch category ids, as in the categories of a Farfetch product (examples: ["135967"])
• min_price integer nullable — Lowest price in the market currency (min: 0)
• max_price integer nullable — Highest price in the market currency (min: 1)
• fast_delivery boolean — Only items with fast delivery (default: false)
• count integer required — Max number of products to return (min: 1; max: 5000)
• query string required — Search keywords (examples: "dress", "prada loafers"; minLength: 1)
• sort string — Result ordering (default: "recommended"; one of: "recommended", "newest", "price_desc", "price_asc")
• brand_ids array nullable — Farfetch brand ids, as brand_id in Farfetch results (examples: ["7199"])

Response

• @type string (default: "FarfetchProductCard")
• id string required
• url string nullable
• name string nullable
• brand string nullable
• brand_id string nullable
• merchant_id string nullable
• market string nullable
• price object nullable
  • @type string (default: "FarfetchPrice")
  • currency string nullable
  • currency_symbol string nullable
  • price number nullable
  • original_price number nullable
  • discount_percent number nullable
  • price_type string nullable
  • tax_note string nullable
  • tax_type string nullable
  • tags array (default: [])
• label string nullable
• stock_quantity integer nullable
• sizes array (default: [])
• availability array (default: [])
• promotion_ids array (default: [])
• tag_ids array (default: [])
• return_restrictions array (default: [])
• is_for_members boolean nullable
• image string nullable
• images array (default: [])

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.