# /iosys/products

`POST /api/iosys/products`

Price: 1 credit

Get one Iosys (イオシス) listing by its product number or product URL: the exact second-hand unit the shop is selling with its price, condition rank, warranty, how many copies are in stock, the bundled accessories, the shop's own note on that unit, the full specification sheet as text and as a field-by-field table, storage, SIM size, colour, release month, photographs, the model family it belongs to and its place in the catalogue taxonomy.

## How to use it

Fetch one Iosys listing by its product number 商品番号 (digits only, e.g. '227036') or by a full iosys.co.jp/items/... URL. Iosys sells its own second-hand stock, so a listing is one physical batch of a model in one condition, not a catalogue title: two units of the same phone in different condition ranks are two different product numbers. Returns id, url, name, image and thumbnail, price and stock, condition (the Japanese rank label such as 中古Aランク, 中古Bランク, 中古Cランク, 未使用品) with condition_id, warranty, accessories, note, spec_text and spec (the same specification sheet split into labelled fields, which is where RAM, processor, screen size and the rest live), storage_gb, sim_size, color, release_date, model_id and model_name (the model family shared by every colour and capacity), category_path (usable as the category filter of the search endpoint), category, genre and genre_slug, brand and the department/section the catalogue files it under. Prices are tax-included JPY. A listing disappears from the catalogue once the batch is sold out. Note that color carries the shop's own colour family used by its search facet, such as silver or black, and not the marketing colour name the model is sold under, which name and spec carry.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `product` (string, required) — Iosys product number (商品番号) or a full product URL (examples: "227036", "https://iosys.co.jp/items/smartphone/iphone13/simfree/iphone13_a2631/227036")

## Response

### 200 — Successful Response

- `@type` (string) (default: "IosysProduct")
- `id` (string, required)
- `url` (string, required)
- `name` (string, nullable)
- `image` (string, nullable)
- `thumbnail` (string, nullable)
- `price` (number, nullable)
- `currency` (string) (default: "JPY")
- `stock` (integer, nullable)
- `condition` (string, nullable)
- `condition_id` (string, nullable)
- `warranty` (string, nullable)
- `warranty_id` (string, nullable)
- `accessories` (string, nullable)
- `note` (string, nullable)
- `spec_text` (string, nullable)
- `spec` (object) (default: {})
  - `*` (string)
- `storage_gb` (integer, nullable)
- `sim_size` (string, nullable)
- `color` (string, nullable)
- `release_date` (string, nullable)
- `model_id` (string, nullable)
- `model_name` (string, nullable)
- `category_path` (string, nullable)
- `category` (string, nullable)
- `category_id` (string, nullable)
- `genre` (string, nullable)
- `genre_id` (string, nullable)
- `genre_slug` (string, nullable)
- `brand` (string, nullable)
- `brand_id` (string, nullable)
- `department` (string, nullable)
- `department_id` (string, nullable)
- `section` (string, nullable)
- `section_id` (string, nullable)

## Errors

### 422 — Validation Error

Malformed product (an Iosys product number is digits only, e.g. '227036')

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

Product not found (well-formed product number but no such listing on iosys.co.jp)

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.