# /ifixit/products/search

`POST /api/ifixit/products/search`

Price: 10 credits

Search the iFixit parts and tools store by keywords, device, category, price and stock

## How to use it

Finds parts and tools across iFixit's regional stores, and it is the only place the region is chosen: prices, stock and the catalogue itself change with store_region, so set it before comparing prices. One row is one offer, not one product — a part sold both bare and as a fix kit returns two rows sharing a product_code, and alias is the handle the product endpoint takes. device, category, item_type, device_brand, device_type and capacity match the store's own wording exactly, so put loose phrasing in query. Rows carry no compatibility list or specification table; fetch the product for those.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `query` (string, nullable) — Words to match in the product name, description and part numbers. Omit to browse by filters alone
- `count` (integer, required) — Max number of results (min: 1; max: 1000)
- `store_region` (string) — Which regional iFixit store to price and stock the results against (default: "en_us"; one of: "en_us", "en_eu", "en_au", "en_ca", "de_de", "fr_fr", "fr_ca")
- `device` (array) — Exact device names the part is sold for (default: []; examples: ["iPhone 13"])
- `category` (array) — Store category names (default: []; examples: ["Batteries"])
- `main_category` (array) — Top-level split of the catalogue (default: []; one of: "Parts", "Tools", "Upgrades", "iFixit Gear")
- `item_type` (array) — What kind of item it is, in the store's own wording (default: []; examples: ["Batteries"])
- `device_brand` (array) — Brand of the device the part is for (default: []; examples: ["Apple"])
- `device_category` (array) — Broad class of the device the part is for (default: []; examples: ["Phone"])
- `device_type` (array) — Model family of the device the part is for (default: []; examples: ["iPhone"])
- `operating_system` (array) — Operating system of the device the part is for (default: []; one of: "Windows", "Android", "iOS", "macOS")
- `part_or_kit` (array) — Whether the offer is the bare part or a kit around it (default: []; one of: "Part Only", "Fix Kit", "Upgrade Kit")
- `capacity` (array) — Storage or battery capacity of the item (default: []; examples: ["512 GB"])
- `tool_category` (array) — Where a tool sits in the tool catalogue (default: []; examples: ["Cleaning"])
- `screwdriver_type` (array) — Build of a screwdriver (default: []; examples: ["Interchangeable Bits"])
- `merchandise_category` (array) — Kind of branded merchandise (default: []; examples: ["Clothing"])
- `ifixit_exclusive_only` (boolean) — Keep only items iFixit sells nowhere else (default: false)
- `price_min` (number, nullable) — Lowest price to accept, in the store's currency (min: 0)
- `price_max` (number, nullable) — Highest price to accept, in the store's currency (min: 0)
- `min_rating` (number, nullable) — Lowest average customer rating to accept, out of five (min: 0; max: 5)
- `min_rating_count` (integer, nullable) — Only products rated by at least this many customers (min: 0)
- `in_stock_only` (boolean) — Keep only offers the store can ship now (default: false)
- `lifetime_warranty_only` (boolean) — Keep only offers covered by iFixit's lifetime warranty (default: false)
- `discounted_only` (boolean) — Keep only offers currently marked down (default: false)

## Response

### 200 — Successful Response

- `@type` (string) (default: "IfixitProductOffer")
- `id` (string, required)
- `name` (string, required)
- `alias` (string, required)
- `url` (string, nullable)
- `product_code` (string, nullable)
- `product_id` (string, nullable)
- `offer_key` (string, nullable)
- `display_name` (string, nullable)
- `description` (string, nullable)
- `image` (string, nullable)
- `store_region` (string, nullable)
- `price` (number, nullable)
- `price_min` (number, nullable)
- `price_max` (number, nullable)
- `price_band` (string, nullable)
- `compare_at_price` (number, nullable)
- `is_discounted` (boolean, nullable)
- `is_pro` (boolean, nullable)
- `is_in_stock` (boolean, nullable)
- `is_public` (boolean, nullable)
- `has_lifetime_warranty` (boolean, nullable)
- `quantity_available` (integer, nullable)
- `rating` (number, nullable)
- `rating_count` (integer, nullable)
- `score` (integer, nullable)
- `oem_partner_code` (string, nullable)
- `oem_partner_url` (string, nullable)
- `devices` (array) (default: [])
- `categories` (array) (default: [])
- `option_values` (array) (default: [])
- `works_in` (array) (default: [])
- `identifiers` (array) (default: [])
- `compatible_part_numbers` (array) (default: [])
- `keywords` (array) (default: [])
- `attributes` (array) (default: [])
  - `@type` (string) (default: "IfixitProductAttribute")
  - `name` (string, required)
  - `values` (array) (default: [])
- `attributes_localized` (array) (default: [])
  - `@type` (string) (default: "IfixitProductAttribute")
  - `name` (string, required)
  - `values` (array) (default: [])
- `search_tags` (array) (default: [])
  - `@type` (string) (default: "IfixitProductAttribute")
  - `name` (string, required)
  - `values` (array) (default: [])
- `axes` (array) (default: [])
  - `@type` (string) (default: "IfixitOfferAxis")
  - `code` (string, required)
  - `values` (array) (default: [])
    - `@type` (string) (default: "IfixitOfferAxisValue")
    - `value` (string, required)
    - `raw_value` (string, nullable)
    - `price_from` (number, nullable)
    - `variant_count` (integer, nullable)

## 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.