/ceneo/categories

POST /api/ceneo/categories

Price: 20 credits

Walk the Ceneo category tree. With a category alias it returns that category with its numeric id, how many products sit in it, the aggregate buyer rating of the category, whether it is a leaf, the path of parent categories, its child categories or - for a leaf - its sibling categories, and the categories Ceneo links as related. With no category it returns the top-level departments, each with the popular child categories shown in the site menu.

How to use it

Start here to find the alias a product search should be scoped to. Aliases are the Polish URL segments (`Smartfony`, `Telefony_i_akcesoria`), which is what /ceneo/products/search and /ceneo/categories/filters both take. Descend through `children` until `is_leaf`; on a leaf Ceneo shows its neighbours instead, which arrive as `siblings`. Only the category you ask for carries `id` and `product_count`, so descend one level to get a child's.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string nullable — Ceneo category to describe: its URL alias or a full category URL. Omit it to get the top-level departments instead (examples: "Smartfony", "Telefony_i_akcesoria", "https://www.ceneo.pl/Smartfony")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "CeneoCategory")
• alias string required
• id string nullable
• name string nullable
• url string nullable
• product_count integer nullable
• rating number nullable
• rating_count integer nullable
• is_leaf boolean nullable
• breadcrumbs array (default: [])
  • @type string (default: "CeneoBreadcrumb")
  • id string nullable
  • alias string nullable
  • name string nullable
  • url string nullable
• children array (default: [])
  • @type string (default: "CeneoCategoryLink")
  • alias string required
  • name string nullable
  • url string nullable
• siblings array (default: [])
  • @type string (default: "CeneoCategoryLink")
  • alias string required
  • name string nullable
  • url string nullable
• related array (default: [])
  • @type string (default: "CeneoCategoryLink")
  • alias string required
  • name string nullable
  • url 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 Ceneo category with that alias. 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.