/jysk/products/category

POST /api/jysk/products/category

Price: 20 credits

List the products of a JYSK Netherlands category page, optionally narrowed by the category's own filters (width, height, depth, colour, type and more), price range or promotion; returns product cards with price, discount, rating and availability flags

How to use it

Category URLs come from jysk/categories; a department landing page such as /woonkamer is not a listing and returns 412. Filter names and values are the ones the category page shows; an unknown one returns 422 listing the available names. Pass a card id to jysk/products for dimensions.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_url string required — jysk.nl category URL (examples: "https://jysk.nl/woonkamer/banken", "https://jysk.nl/slaapkamer/matrassen/topmatrassen?filters=f_21%3ATopmatras"; minLength: 1)
• count integer required — Max number of products to return (min: 1)
• price_min number nullable — Minimum price in EUR (examples: 100; min: 0)
• price_max number nullable — Maximum price in EUR (examples: 300; min: 0)
• on_sale boolean — Only discounted products (default: false)
• filters array — Category filters by name; values within one filter are alternatives, filters combine (default: []; examples: [{"name":"Breedte (cm)","values":["137","138"]},{"name":"Kleur","values":["Grijs"]}])
  • name string required — Filter name as shown on jysk.nl (examples: "Breedte (cm)"; minLength: 1)
  • values array — Filter values (default: []; examples: ["137","200"])

Response

• @type string (default: "JyskProductCard")
• id string required
• url string required
• title string nullable
• categories array (default: [])
• price number nullable
• original_price number nullable
• lowest_price_30d number nullable
• previous_price number nullable
• currency string (default: "EUR")
• price_unit string nullable
• discount_percent number nullable
• campaign_started_at integer nullable
• campaign_ends_at integer nullable
• recycling_fee number nullable
• rating number nullable
• image string nullable
• images array (default: [])
• brand string nullable
• series string nullable
• family_id string nullable
• status_code string nullable
• quality string nullable
• energy_label_image string nullable
• energy_class_image string nullable
• is_everyday_low_price boolean nullable
• labels array (default: [])
• is_online_sales boolean nullable
• is_store_sales boolean nullable
• is_click_collect boolean nullable
• is_online_only boolean nullable
• is_store_only boolean nullable
• is_outlet boolean nullable
• is_new boolean nullable
• is_price_hero boolean nullable
• is_single_out boolean nullable
• is_special_sale boolean nullable
• is_while_stock_lasts boolean nullable
• is_discontinued_soon boolean nullable
• is_direct_delivery_from_vendor boolean nullable
• has_more_sizes boolean nullable
• variant_options array (default: [])
  • @type string (default: "JyskVariantOption")
  • name string required
  • values array (default: [])
• variants array (default: [])
  • @type string (default: "JyskVariant")
  • id string required
  • options array (default: [])
    • @type string (default: "JyskSpec")
    • name string required
    • value string required
  • price number nullable
  • image string nullable
• set_component_ids 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 — JYSK has no product listing under that category URL 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.