/askul/products

POST /api/askul/products

Price: 10 credits

Get an ASKUL (アスクル) product by order code (お申込番号) or product URL: name, price with and without tax, stock, delivery date, maker, brand, manufacturer part number (型番), JAN code, sales unit, rating, review count, cumulative purchase count, ASKUL environmental score, the full category-specific specification table, category breadcrumbs, promotion tags and keyword tags.

How to use it

Get one ASKUL (アスクル, Japanese B2B office/facility/MRO supplier) product. `item` accepts the bare order code お申込番号 (e.g. '688881') or a full product URL. `price` is excluding tax and `price_with_tax` including tax — ASKUL is a business catalog and shows both. `specs` is the full category-specific specification table. `family_id` links to the sibling sizes and pack sizes of the same product — expand it with askul/products/variants. `category_id` is the dash-joined category path that askul/categories and askul/products/search take as `category`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — ASKUL order code (お申込番号) or a full product URL (examples: "688881", "https://www.askul.co.jp/p/688881/"; minLength: 1)

Response

• @type string (default: "AskulProduct")
• id string required
• url string required
• name string required
• description string nullable
• image string nullable
• images array (default: [])
• price number nullable
• price_with_tax number nullable
• currency string (default: "JPY")
• in_stock boolean nullable
• delivery_date string nullable
• maker string nullable
• brand string nullable
• model string nullable
• jan_code string nullable
• sales_unit string nullable
• rating number nullable
• review_count integer nullable
• purchase_count integer nullable
• eco_score integer nullable
• family_id string nullable
• family_url string nullable
• variant_count integer nullable
• variant_axis string nullable
• category_id string nullable
• category string nullable
• breadcrumbs array (default: [])
  • @type string (default: "AskulBreadcrumb")
  • name string required
  • url string nullable
• tags array (default: [])
• keywords array (default: [])
• specs object (default: {})
  • * string

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 not found (well-formed order code but no such product on ASKUL) 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.