/sofmap/used_products/categories

POST /api/sofmap/used_products/categories

Price: 10 credits

Get the category tree of Sofmap's リコレ！ (Recore) second-hand catalogue: every top-level category with its subcategories and, for both levels, the specification facets that category supports together with every value each facet accepts.

How to use it

The taxonomy behind used.sofmap.com (リコレ！). This tree is separate from the sofmap.com category tree: it uses slugs such as 'pc', 'iphone' or 'kaden-kitchen1' rather than numeric codes. Each entry has id (the category field of used_products/search), name, full_name, url, description, subcategories (each id goes into the subcategory field, and carries its own facets) and facets. A facet has an id, a Japanese name and its values; pass them to used_products/search as specs, keyed on the facet id. Which facets exist depends on the category, and several of them exist only on a subcategory, so read them at the level you are going to search in.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string nullable — Return only this top-level category (one of: "pc", "gaming", "smp", "tab", "wtc", "mac", "iphone", "ipad", "surface", "video", "cam", "dslr", "lens", "headphone", "audio", "visual", "rec-visual", "device", "parts", "game", "kaden-life", "kaden-light", "kaden-joho", "kaden-season", "kaden-kitchen1", "kaden-kitchen2", "kaden-appearance", "kaden-beauty")
• count integer required — Max number of categories to return (min: 1)

Response

• @type string (default: "SofmapUsedCategoryEntry")
• id string required
• name string nullable
• full_name string nullable
• url string required
• description string nullable
• subcategories array (default: [])
  • @type string (default: "SofmapUsedSubcategory")
  • id string required
  • name string nullable
  • url string required
  • facets array (default: [])
    • @type string (default: "SofmapUsedFacet")
    • id string required
    • name string nullable
    • values array (default: [])
• facets array (default: [])
  • @type string (default: "SofmapUsedFacet")
  • id string required
  • name string nullable
  • values array (default: [])
    • @type string (default: "SofmapUsedFacetValue")
    • value string required
    • name 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.