# /askul/products/search

`POST /api/askul/products/search`

Price: 20 credits

Search the ASKUL (アスクル) catalog by keyword, category level, maker, brand, series, price range, delivery speed, product programme and category-specific specification facets. Returns product cards with price including tax, per-unit price, rating, cumulative purchase count, variant count, delivery date and promotion tags.

## How to use it

Search ASKUL (アスクル, Japanese B2B office/facility/MRO supplier, ~16M catalogue lines). Every filter is optional except `count`; with no filter it browses the whole catalog. Most results are product FAMILIES (`is_family=true`) — `id` is then a family id for askul/products/variants and `variant_count` says how many order codes it holds, while `price_with_tax` is the cheapest variant and `has_price_range` marks that the variants differ in price. `specs`, `makers`, `brands`, `series` and `tags` ids come from askul/categories for the category you intend to search.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `keyword` (string, nullable) — Free-text search keyword (examples: "コピー用紙", "ハンドソープ")
- `count` (integer, required) — Max number of results to return (min: 1)
- `exclude_keyword` (string, nullable) — Exclude products matching this keyword
- `name_and_category_only` (boolean) — Match the keyword against product and category names only (default: false)
- `category` (string, nullable) — Dash-joined category path to search within, as returned by askul/categories (examples: "02", "02-0203", "02-0203-0203001")
- `maker` (string, nullable) — Maker id, as listed in the `makers` of askul/categories (examples: "40010010117")
- `brand` (string, nullable) — Brand id, as listed in the `brands` of askul/categories (examples: "31010010655")
- `series` (string, nullable) — Series id, as listed in the `series` of askul/categories (examples: "102912")
- `specs` (array, nullable) — Category-specific specification filters, given as option ids from the `specs` of askul/categories. Ids of the same facet are combined with OR, different facets with AND (examples: ["000013_サイズ_17500_A4"])
- `tags` (array, nullable) — Product programme filters, as listed in the `tags` of askul/categories (examples: ["16000"], ["07000"])
- `price_min` (integer, nullable) — Minimum price in JPY, including tax (min: 0)
- `price_max` (integer, nullable) — Maximum price in JPY, including tax (min: 0)
- `fast_delivery_only` (boolean) — Only products delivered within two days (default: false)
- `exclude_drop_shipped` (boolean) — Exclude drop-shipped and back-ordered products (default: false)
- `sort` (string) — Result ordering (default: "recommended"; one of: "recommended", "price_asc", "price_desc", "rating_desc", "review_count_desc", "newest")

## Response

### 200 — Successful Response

- `@type` (string) (default: "AskulSearchItem")
- `id` (string, required)
- `url` (string, required)
- `name` (string, required)
- `is_family` (boolean, required)
- `image` (string, nullable)
- `description` (string, nullable)
- `price_with_tax` (number, nullable)
- `unit_price_with_tax` (number, nullable)
- `has_price_range` (boolean, nullable)
- `currency` (string) (default: "JPY")
- `rating` (number, nullable)
- `purchase_count` (integer, nullable)
- `variant_count` (integer, nullable)
- `delivery_date` (string, nullable)
- `tags` (array) (default: [])

## Errors

### 422 — Validation Error

The request body did not validate

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

The entity was not found, or a precondition failed

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.