# /sofmap/products

`POST /api/sofmap/products`

Price: 5 credits

Get full Sofmap (ソフマップ) product details by product number or product URL: name, brand, maker, model number, JAN code, colour, images, tax-included and tax-excluded price, Sofmap point reward, second-hand condition rank and bundled accessories, stock and shipping lines, the shop that carries the item, release date, the full product description, spec table, category breadcrumbs, rating and review count, the number and starting price of second-hand copies, the same model in its other colours and sizes, and the products shown alongside it.

## How to use it

Fetch one Sofmap product by its product number (e.g. '101213779') or a full product URL. Sofmap sells both new and second-hand stock under the same product numbers: product_type says which one this is, and a second-hand item also carries used_rank (S unused, A mint, B good, C fair, D faulty, E junk) with used_rank_description and accessories. Returns name, brand, maker, model_number, jan, color, image/images, view_360_url, price with price_without_tax and tax in JPY, point and point_note, stock_status/stock_message/availability_note/purchase_limit, shipping_fee/shipping_group/shipping_message, store (the shop holding a second-hand item), release_date (ISO) with the raw release_date_text and the manufacturer's own maker_release_date/maker_release_date_text, headline (the one-line lead) and description (the full product copy), notes, rating, review_count and review_url, category/category_id/breadcrumbs (category_id is the category filter of the search endpoint), specs, used_count/used_price_from/used_url for the second-hand copies of a new product, variations (the same model in its other colours and sizes, each with its own product number and price) and related_products. All prices are in JPY and tax-included unless stated otherwise. Second-hand stock sold under the リコレ！ brand lives in the used_products endpoints instead.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `product` (string, required) — Sofmap product number (sku) or a full product URL (examples: "101213779", "https://www.sofmap.com/product_detail.aspx?sku=101213779")

## Response

### 200 — Successful Response

- `@type` (string) (default: "SofmapProduct")
- `id` (string, required)
- `url` (string, required)
- `name` (string, nullable)
- `brand` (string, nullable)
- `maker` (string, nullable)
- `model_number` (string, nullable)
- `jan` (string, nullable)
- `color` (string, nullable)
- `product_type` (string) (default: "new"; one of: "all", "new", "used")
- `image` (string, nullable)
- `images` (array) (default: [])
- `view_360_url` (string, nullable)
- `price` (number, nullable)
- `price_without_tax` (number, nullable)
- `tax` (number, nullable)
- `currency` (string) (default: "JPY")
- `point` (integer, nullable)
- `point_note` (string, nullable)
- `used_rank` (string, nullable) (one of: "S", "A", "B", "C", "D", "E")
- `used_rank_description` (string, nullable)
- `accessories` (string, nullable)
- `stock_status` (string, nullable)
- `stock_message` (string, nullable)
- `availability_note` (string, nullable)
- `purchase_limit` (string, nullable)
- `shipping_fee` (number, nullable)
- `shipping_group` (string, nullable)
- `shipping_message` (string, nullable)
- `store` (object, nullable)
  - `@type` (string) (default: "SofmapCardStore")
  - `id` (string, nullable)
  - `name` (string, required)
  - `url` (string, nullable)
- `release_date` (string, nullable)
- `release_date_text` (string, nullable)
- `maker_release_date` (string, nullable)
- `maker_release_date_text` (string, nullable)
- `headline` (string, nullable)
- `description` (string, nullable)
- `notes` (string, nullable)
- `rating` (number, nullable)
- `review_count` (integer, nullable)
- `review_url` (string, nullable)
- `category` (string, nullable)
- `category_id` (string, nullable)
- `breadcrumbs` (array) (default: [])
- `specs` (object) (default: {})
  - `*` (string)
- `used_count` (integer, nullable)
- `used_price_from` (number, nullable)
- `used_url` (string, nullable)
- `variations` (array) (default: [])
  - `@type` (string) (default: "SofmapRelatedProduct")
  - `id` (string, required)
  - `url` (string, required)
  - `name` (string, nullable)
  - `brand` (string, nullable)
  - `image` (string, nullable)
  - `price` (number, nullable)
  - `point` (integer, nullable)
  - `stock_message` (string, nullable)
- `related_products` (array) (default: [])
  - `@type` (string) (default: "SofmapRelatedProduct")
  - `id` (string, required)
  - `url` (string, required)
  - `name` (string, nullable)
  - `brand` (string, nullable)
  - `image` (string, nullable)
  - `price` (number, nullable)
  - `point` (integer, nullable)
  - `stock_message` (string, 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

Product not found (well-formed product number but no such product on sofmap.com)

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.