# /fonq/products/search

`POST /api/fonq/products/search`

Price: 10 credits

Search the fonQ (fonq.nl) catalogue by text, inside a collection or a brand, with fonQ's own facet filters, a price range, discount and next-day-delivery switches and six orderings. Each product card carries the numeric id, URL, name, selling and regular price in euros, stock flags and two images.

## How to use it

Facet slugs differ per collection: materiaal, kleur and manufacturer are common, a chair collection adds armleuning_stoelen with ja or nee. An unknown facet slug or a value the result set does not offer answers 422; a facet fonQ knows but this result set has no products for answers 200 with an empty list. Feed id or url into fonq/products for dimensions and the specification table.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `count` (integer, required) — Max number of products to return (min: 1)
- `query` (string, nullable) — Free-text search term (examples: "eetkamerstoel", "hay about a chair"; minLength: 1)
- `collection` (string, nullable) — fonQ collection slug or collection URL (examples: "eetkamerstoel", "https://www.fonq.nl/collections/tafellampen"; minLength: 1)
- `brand` (string, nullable) — fonQ brand slug or brand page URL, as returned by fonq/brands (examples: "hay", "https://www.fonq.nl/merken/bold-monkey"; minLength: 1)
- `filters` (object, nullable) — Facet filters: facet slug mapped to the value slugs to keep (examples: {"kleur":["beige"],"materiaal":["hout","leer"]}, {"manufacturer":["hay"]})
  - `*` (array)
- `price_min` (number, nullable) — Lowest selling price in euros (min: 0)
- `price_max` (number, nullable) — Highest selling price in euros (min: 0)
- `on_sale` (boolean) — Only discounted products (default: false)
- `next_day_delivery` (boolean) — Only products delivered the next working day (default: false)
- `sort` (string) — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "discount", "best_selling", "newest")
- `page` (integer) — Result page to start from, 60 products per page (default: 1; min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "FonqProductCard")
- `id` (integer, required)
- `url` (string, required)
- `name` (string, nullable)
- `price` (number, nullable)
- `regular_price` (number, nullable)
- `is_discounted` (boolean, nullable)
- `is_salable` (boolean, nullable)
- `is_pre_orderable` (boolean, nullable)
- `is_out_of_stock` (boolean, nullable)
- `image` (string, nullable)
- `hover_image` (string, nullable)
- `piece_count` (integer, nullable)

## Errors

### 422 — Validation Error

One of the filters is not offered for this result set, or a value is not one of its slugs.

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

fonQ serves no collection or brand page under this slug.

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.