/johnlewis/categories

POST /api/johnlewis/categories

Price: 20 credits

Get a John Lewis category (navigation tree) by content id (or category URL): id, name, type, URL, SEO metadata, and the nested child tree of subcategories and browse links.

How to use it

Fetch a John Lewis category hub by numeric content id or a category URL. Returns one item with id, content_id, name, type (e.g. DEPARTMENT), url, meta_title, meta_description, included_in_menus, and children — the nested navigation tree. Each child node has id, content_id, name, type (HEADER, CATEGORY_PAGE, PRODUCT_LIST, NAVIGATION_LINK), url and its own nested children. Use the browse/listing URLs found in the tree (or johnlewis/categories/products) to list the products within a category.

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 category content id or a category URL containing it (examples: "500001", "https://www.johnlewis.com/electricals/c500001"; minLength: 1)

Response

• @type string (default: "JohnlewisCategory")
• id string nullable
• content_id string nullable
• name string required
• type string nullable
• url string nullable
• meta_title string nullable
• meta_description string nullable
• included_in_menus array (default: [])
• children array (default: [])
  • @type string (default: "JohnlewisCategoryNode")
  • id string nullable
  • content_id string nullable
  • name string required
  • type string nullable
  • url string nullable
  • included_in_menus array (default: [])
  • children 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 — Category not found (well-formed but nonexistent content 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.