/praxis/products/search

POST /api/praxis/products/search

Price: 10 credits

Search Praxis Netherlands products by keyword, list a category, or both, with price, seller, brand, delivery, promotion, rating and product attribute filters; returns product cards with package and unit prices, units per package, promotions, seller, availability and rating

How to use it

Category codes are the category ids shown in product cards; with query the search is limited to that category. Attribute filter names and values are the ones praxis.nl offers for the search, and an unknown name returns 422 listing the available ones. Cards carry no dimensions: pass the id to praxis/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", "muurverf wit"; minLength: 1)
• category string nullable — Category code (examples: "fl026", "wc0028"; pattern: ^[A-Za-z]{1,2}\d+$)
• count integer required — Max number of products to return (min: 1; max: 10000)
• sort string — Result order (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "discount_desc", "newest", "rating")
• price_min number nullable — Minimum package price in EUR (examples: 10; min: 0)
• price_max number nullable — Maximum package price in EUR (examples: 50; min: 0)
• sellers array — Seller names (default: []; examples: ["Praxis"], ["Praxis","Egger"])
• brands array — Brand names (default: []; examples: ["Egger"])
• delivery array — Delivery or pickup options (default: []; one of: "home_delivery", "in_store")
• promotions array — Promotion types (default: []; one of: "on_sale", "praxis_plus", "fixed_low_price")
• min_rating integer nullable — Minimum average review rating (min: 1; max: 5)
• filters array — Product attribute filters; values within one filter are alternatives, filters combine (default: []; examples: [{"name":"catspec_v_groove","values":["4-zijdig"]}])
  • name string required — Filter name (examples: "catspec_v_groove", "core_consumer_unit_width"; minLength: 1)
  • values array required — Filter values (examples: ["4-zijdig"]; minItems: 1)

Response

• @type string (default: "PraxisProductCard")
• id string required
• url string nullable
• title string nullable
• ean string nullable
• image string nullable
• category object nullable
  • @type string (default: "PraxisCategory")
  • id string required
  • name string nullable
• categories array (default: [])
  • @type string (default: "PraxisCategory")
  • id string required
  • name string nullable
• brand string nullable
• brand_code string nullable
• seller string nullable
• is_marketplace boolean nullable
• offer_id string nullable
• currency string nullable
• price number nullable
• regular_price number nullable
• discount_price number nullable
• unit string nullable
• units_per_package number nullable
• price_per_unit number nullable
• regular_price_per_unit number nullable
• is_package_price_first boolean nullable
• is_excluded_from_discounts boolean nullable
• promotions array (default: [])
  • @type string (default: "PraxisPromotion")
  • code string nullable
  • group string required
  • price number nullable
  • percentage number nullable
  • discount_type string nullable
  • discount_value number nullable
  • priority integer nullable
  • amount number nullable
  • qualified_quantity integer nullable
  • action_quantity integer nullable
  • bundle_price number nullable
  • is_member_only boolean nullable
  • is_choice_discount boolean nullable
  • is_excluded_by_discount_group boolean nullable
  • is_percentage boolean nullable
  • is_same_products boolean nullable
  • is_target boolean nullable
  • is_qualified boolean nullable
  • label string nullable
  • qualifying_product_ids array (default: [])
  • target_product_ids array (default: [])
  • target_product_name string nullable
  • target_product_image string nullable
  • customer_groups array (default: [])
  • started_at integer nullable
  • ends_at integer nullable
• shipping_cost number nullable
• availability string nullable
• availability_details array (default: [])
• delivery_modes array (default: [])
  • @type string (default: "PraxisDeliveryMode")
  • code string required
  • name string nullable
  • description string nullable
  • method string nullable
  • cost number nullable
  • free_from number nullable
  • earliest_days integer nullable
  • latest_days integer nullable
• rating number nullable
• review_count integer nullable
• labels array (default: [])
• label_details array (default: [])
  • @type string (default: "PraxisLabel")
  • text string required
  • title string nullable
  • description string nullable
  • link_url string nullable
  • link_text string nullable
• energy_rating string nullable
• energy_rating_scale string nullable
• energy_label_image string nullable
• repairability_index number nullable
• is_sponsored boolean nullable
• sponsor string nullable
• is_discontinued boolean nullable
• is_online_only boolean nullable
• is_own_brand boolean nullable
• is_ecocheque boolean nullable
• is_sustainable boolean nullable
• is_disabled boolean 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 — The entity was not found, or a precondition failed 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.