/monotaro/products/variants

POST /api/monotaro/products/variants

Price: 20 credits

List every SKU (size / shape / packaging variant) of a MonotaRO (モノタロウ) product family: order code, sub-name, brand, category, price with and without tax, list price, packaging unit, shipping lead time, the variant-defining attributes, the full specification table and linked documents (safety data sheets, RoHS certificates).

How to use it

List all SKUs of a MonotaRO (モノタロウ) product family. One family (e.g. 'hex bolt, fully threaded') holds dozens or hundreds of SKUs that differ by size, length, finish or pack quantity, each with its own order code (注文コード) and its own price. Accepts a product-group code (商品コード), any order code of the family, or a product URL — the two code spaces overlap, so set `code_type` when you pass bare digits, or pass the URL. `attributes` holds the variant-defining values (thread size, length, tip shape…), `specs` the complete attribute table of that SKU and `documents` its attached PDFs (safety data sheet, RoHS certificate). `price` is the SKU's cheapest lot price and `max_price` its dearest — they differ only where the SKU is sold in several lot sizes. Feed `id` back into monotaro/products to get the single-SKU view.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — MonotaRO product-group code (商品コード, e.g. '00010489'), any order code (注文コード) belonging to the family, or a full product URL (examples: "00010489", "https://www.monotaro.com/g/00010489/", "02197517"; minLength: 1)
• count integer required — Max number of variants to return (min: 1)
• code_type string — Which code space `product` belongs to when it is passed as bare digits. The two code spaces overlap — the same eight digits can name one SKU and a different whole product family. Ignored when `product` is a URL (default: "order_code"; one of: "order_code", "product_code")

Response

• @type string (default: "MonotaroVariant")
• id string required
• url string required
• product_code string required
• product_url string required
• sub_name string nullable
• brand string nullable
• brand_id string nullable
• maker_product_code string nullable
• image string nullable
• images array (default: [])
• price number nullable
• price_with_tax number nullable
• max_price number nullable
• list_price number nullable
• list_price_with_tax number nullable
• currency string (default: "JPY")
• quantity string nullable
• ship_days integer nullable
• is_orderable boolean nullable
• is_private_brand boolean nullable
• is_sellable_to_consumer boolean nullable
• category string nullable
• category_id string nullable
• attributes object (default: {})
  • * string
• specs object (default: {})
  • * string
• documents array (default: [])
  • @type string (default: "MonotaroDocument")
  • name string required
  • url string required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 family not found (well-formed code but no such product on MonotaRO) 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 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 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 Wait at least 30 seconds, then retry.

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