/misumi/products/search

POST /api/misumi/products/search

Price: 20 credits

Search the MISUMI (ミスミ) catalog by keyword, category, manufacturer, category-specific specification filters, shipping lead time, stock, CAD availability and RoHS compliance. Returns series cards with the price range in JPY excluding tax, shipping lead time, rating, category breadcrumbs, images and the comparison specifications the category ranks products by.

How to use it

Search MISUMI (ミスミ, Japanese B2B catalog of mechanical components, fasteners and factory automation parts). At least one of `keyword`, `category`, `brand` or `rohs_only` must be given. Results are **series** — configurable families, each with a price range across its part numbers; feed an `id` back into misumi/products for the family or misumi/products/variants for its individual part numbers. `attributes` filters on the specification axes of a category (thread size, material, stroke …) and needs `category` to take effect; get the ids and values from misumi/categories. `sort`, `in_stock_only` and `max_days_to_ship` apply to a category or manufacturer scope; with a keyword they need `exact_match` as well, which also narrows the keyword to literal matches. Prices are JPY excluding consumption tax. A keyword search never reaches beyond 8000 matches, so scope by `category` or `brand` to walk a large result set.

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: "六角穴付ボルト", "エアシリンダ"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• category string nullable — Category id to search within, as returned by misumi/categories (examples: "M3311010000")
• brand string nullable — Manufacturer id, as returned by misumi/manufacturers or misumi/manufacturers/search (examples: "MSM1", "SMC1")
• attributes object nullable — Category-specific specification filters as {specification id: value}. Ids and their allowed values differ per category and are listed in the `filters` of that category in misumi/categories. Several values for one id can be given comma-separated (examples: {"SP100255553":"b"})
  • * string
• max_days_to_ship integer nullable — Only series that ship within this many days (0 = same day) (min: 0; max: 99)
• in_stock_only boolean — Only series held in stock (default: false)
• with_cad_only boolean — Only series that publish CAD data (default: false)
• rohs_only boolean — Only series with a RoHS-compliant option (default: false)
• economy_only boolean — Only series from MISUMI's lower-cost economy line (エコノミーシリーズ) (default: false)
• include_discontinued boolean — Include series that are no longer manufactured (default: false)
• exact_match boolean — Match the keyword literally instead of the source's semantic expansion. Narrows the result set and is what makes `sort`, `in_stock_only` and `max_days_to_ship` apply to a keyword search (default: false)
• sort string — Result ordering (default: "recommended"; one of: "recommended", "price_asc", "popular", "days_to_ship_asc")

Response

• @type string (default: "MisumiSearchItem")
• id string required
• url string required
• name string required
• description string nullable
• brand object nullable
  • @type string (default: "MisumiBrandRef")
  • id string required
  • name string required
  • alias string nullable
  • url string nullable
  • is_misumi boolean nullable
• category_id string nullable
• category_name string nullable
• department_id string nullable
• breadcrumbs array (default: [])
  • @type string (default: "MisumiCategoryRef")
  • id string required
  • name string required
  • url string nullable
• image string nullable
• images array (default: [])
  • @type string (default: "MisumiImage")
  • url string required
  • caption string nullable
• shape_image string nullable
• min_price number nullable
• max_price number nullable
• min_price_per_piece number nullable
• max_price_per_piece number nullable
• currency string (default: "JPY")
• min_pieces_per_package integer nullable
• max_pieces_per_package integer nullable
• min_days_to_ship integer nullable
• max_days_to_ship integer nullable
• min_shortest_days_to_ship integer nullable
• max_shortest_days_to_ship integer nullable
• rating number nullable
• view_count integer nullable
• is_stock_item boolean nullable
• is_discontinued boolean nullable
• is_package_spec boolean nullable
• is_special_shipment boolean nullable
• has_volume_discount boolean nullable
• is_economy boolean nullable
• grade string nullable
• cad_types array (default: [])
• labels array (default: [])
• pictograms array (default: [])
  • @type string (default: "MisumiPictogram")
  • name string required
  • description string nullable
• rohs object nullable
  • @type string (default: "MisumiCompliance")
  • standard string required
  • status string nullable
• chemsherpa object nullable
  • @type string (default: "MisumiCompliance")
  • standard string required
  • status string nullable
• summary string nullable
• is_recommended boolean nullable
• comparison_specs array (default: [])
  • @type string (default: "MisumiSpec")
  • id string required
  • name string required
  • value string required
  • filter_value string nullable
  • group string nullable
  • group_value string nullable
  • code string nullable
  • unit string nullable
  • image string nullable
  • diagram string nullable

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 — The entity was not found, or a precondition failed 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.