/karwei/products/search

POST /api/karwei/products/search

Price: 20 credits

Search Karwei products by text, category or both, with price, brand, on-sale, attribute and numeric range filters and the shop's sorts: listed price and price per m², dimensions, attributes, stock and delivery.

How to use it

Attribute filters take the keys and values a product shows in its features, such as kleurfamilie; an unknown key or value answers 422 listing the available ones. One search reaches at most 1,000 products, so split a broad one by category or price. Floors and tiles list their current price per m² in price_per_m2 (price is empty); the price of one pack, regular and loyalty-card prices and pack coverage in m² are on karwei/products.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Search text (examples: "laminaat eiken", "boormachine")
• category string nullable — Category path or category URL (examples: "/vloeren/laminaat", "https://www.karwei.nl/assortiment/l/vloeren/laminaat")
• count integer required — Max number of products to return (min: 1; max: 1000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "rating", "best_selling")
• price_min number nullable — Lowest listed price in EUR (min: 0)
• price_max number nullable — Highest listed price in EUR (min: 0)
• on_sale boolean — Keep only products with a promotion running (default: false)
• brands array nullable — Brand names to keep (examples: ["Bosch","Makita"])
• attributes array nullable — Attribute filters (examples: [{"name":"kleurfamilie","values":["Beige","Bruin"]}])
  • entity_type string (default: "")
  • name string required — Filter attribute key, as in a product's features (minLength: 1)
  • values array required — Values to keep (minItems: 1)
• attribute_ranges array nullable — Numeric attribute ranges (examples: [{"max":8,"min":7,"name":"dikte_lamel"},{"max":10,"name":"price_per_m2"}])
  • entity_type string (default: "")
  • name string required — Numeric attribute key (minLength: 1)
  • min number nullable — Lowest value to keep
  • max number nullable — Highest value to keep

Response

• @type string (default: "KarweiListedProduct")
• id string required
• article_number string nullable
• ean string nullable
• name string nullable
• url string nullable
• image string nullable
• images array (default: [])
• brand string nullable
• category_names array (default: [])
• category_paths array (default: [])
• price number nullable
• price_per_m2 number nullable
• price_from number nullable
• unit_price_unit string nullable
• sales_unit string nullable
• vat_rate number nullable
• is_on_sale boolean nullable
• discount_labels array (default: [])
• rating number nullable
• rating_count integer nullable
• width_mm number nullable
• depth_mm number nullable
• height_mm number nullable
• net_weight_g number nullable
• pack_coverage number nullable
• pack_coverage_unit string nullable
• pack_coverage_m2 number nullable
• content_volume number nullable
• min_width_cm number nullable
• max_width_cm number nullable
• min_height_cm number nullable
• max_height_cm number nullable
• unit_sizes array (default: [])
• features array (default: [])
  • @type string (default: "IntergammaFeature")
  • key string required
  • values array (default: [])
• attributes array (default: [])
  • @type string (default: "IntergammaAttribute")
  • name string required
  • value string nullable
• variants array (default: [])
  • @type string (default: "IntergammaListedVariant")
  • id string required
  • axis string nullable
  • value string nullable
  • url string nullable
  • image string nullable
  • pack_coverage number nullable
  • pack_coverage_unit string nullable
• short_description string nullable
• highlights array (default: [])
• is_in_stock boolean nullable
• stock_quantity integer nullable
• is_temporarily_out_of_stock boolean nullable
• is_online_orderable boolean nullable
• is_pickup_only boolean nullable
• is_orderable_in_store boolean nullable
• earliest_delivery_date integer nullable
• store_ids array (default: [])
• standard_delivery_cost number nullable
• free_delivery_threshold number nullable
• energy_label string nullable
• energy_scale string nullable
• energy_label_image string nullable
• rental_prices object nullable
  • @type string (default: "IntergammaRentalPrices")
  • day_price number nullable
  • daypart_price number nullable
  • weekend_price number nullable
  • week_price number nullable
  • deposit_price number nullable
• is_configurable boolean nullable
• is_new boolean nullable
• is_outlet boolean nullable
• is_our_choice boolean nullable
• minimum_order_quantity number nullable
• introduced_date integer nullable
• updated_date integer nullable
• sustainability_label 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 category under that path on karwei.nl 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.