/pult/categories/filters

POST /api/pult/categories/filters

Price: 20 credits

List the filters one pult.ru category offers: the brands sold in it, the price bounds, the stock switch and the technical attributes of that category, each with its id and either its selectable values or its numeric bounds. The ids and values are the ones the category product listing accepts.

How to use it

Call this before filtering a category: attribute ids are per category, so an id read from one category means nothing in another. Apply a LIST filter by passing its id with one or more of its values in `attributes`, and a RANGE filter by passing its id with min and max in `attribute_ranges`. Pass a value exactly as printed here.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id string required — Numeric category id, as carried by every product's categories list (examples: "2325"; minLength: 1)
• count integer required — Max number of filters to return (min: 1)

Response

• @type string (default: "PultCategoryFilter")
• id string required
• name string nullable
• hint string nullable
• filter_type string required
• values array (default: [])
  • @type string (default: "PultCategoryFilterValue")
  • value string required
  • name string nullable
  • url string nullable
• min_value number nullable
• max_value number 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 such category id on pult.ru. 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.