/johnlewis/categories/products

POST /api/johnlewis/categories/products

Price: 20 credits

List products within a John Lewis category by browse listing base id (N-...), browse/category URL, or path. Returns the same product cards as search (id, title, brand, price, list_price, rating, review count, images, colour swatches), scoped to the category. Supports result ordering.

How to use it

List products inside a John Lewis category. Accepts a browse listing base id (e.g. N-474sZ1z140en), a full browse/category URL, or a path (e.g. /electricals/laptops-macbooks/c60000876). Base ids and browse URLs come from the children tree returned by johnlewis/categories. Each result is a product card: id, title, brand, url, image, images, price (GBP), list_price, currency, rating, review_count, default_sku_id, is_out_of_stock, is_available_to_order, color_swatches. Use sort to order results. Pair with johnlewis/products for full per-product details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — John Lewis browse listing base id (N-...), browse/category URL, or path (examples: "N-474sZ1z140en", "https://www.johnlewis.com/brand/vacuum-cleaners/dyson/_/N-474sZ1z140en", "/electricals/laptops-macbooks/c60000876"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "priceLow", "priceHigh", "new", "popularity", "discount")

Response

• @type string (default: "JohnlewisSearchProduct")
• id string required
• brand string nullable
• url string nullable
• image string nullable
• images array (default: [])
• price number nullable
• list_price number nullable
• currency string nullable
• rating number nullable
• review_count integer nullable
• default_sku_id string nullable
• is_out_of_stock boolean nullable
• is_available_to_order boolean nullable
• color_swatches array (default: [])
  • @type string (default: "JohnlewisSearchColorSwatch")
  • color string nullable
  • sku_id string nullable
  • image string nullable
  • url string nullable
  • is_available boolean 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 — Category not found (unknown base id, URL or path that yields no products) 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.