/sofmap/used_products/facets

POST /api/sofmap/used_products/facets

Price: 5 credits

Get the filter catalogue of Sofmap's リコレ！ (Recore) second-hand store for one scope: every maker holding stock in it and the price bands the stock falls into, each with the number of copies behind it. The scope is described with the same fields as the second-hand search, so the catalogue matches the search it is going to be used with.

How to use it

The values the maker and price filters of used_products/search accept, with live counts. Scope it the same way you would scope the search — category, subcategory, keyword, used_rank, maker, stock_type, stock_count, specs — and the answer carries unit_count (copies in scope), model_count (distinct models) and one entry per facet. Each facet has an id, the payload_field of the search endpoint it feeds and its values; a value carries unit_count, and a price band also carries price_min and price_max in JPY, which go straight into the price_min/price_max of the search. The maker catalogue is the one published for the category in scope, so read it per category rather than assuming a fixed list; narrowing the scope any further reshapes the price bands rather than the maker list.

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 query (minLength: 1)
• category string nullable — Top-level category of the second-hand catalogue (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")
• subcategory array nullable — Second-level category slugs (from the used_products/categories endpoint) (examples: ["note","desktop"])
• used_rank array nullable — Condition grades to keep: S unused, A mint, B good, C fair, D faulty, E junk (one of: "S", "A", "B", "C", "D", "E")
• maker array nullable — Maker names, as published by the used_products/facets endpoint (examples: ["NEC(エヌイーシー)"])
• stock_type string nullable — Keep only warehouse stock or only shop stock (one of: "warehouse", "store")
• stock_count string nullable — Keep only models held in this many copies (one of: "up_to_5", "5_to_9", "10_to_19", "20_or_more")
• specs object nullable — Category-specific specification filters, keyed by the facet id of the used_products/categories endpoint (examples: {"cpu":["Core i7"],"storage_type_1":["SSD"]})
  • * array

Response

• @type string (default: "SofmapUsedProductFacets")
• unit_count integer nullable
• model_count integer nullable
• facets array (default: [])
  • @type string (default: "SofmapUsedIndexFacet")
  • id string required
  • payload_field string nullable
  • values array (default: [])
    • @type string (default: "SofmapUsedFacetBucket")
    • value string required
    • unit_count integer nullable
    • price_min integer nullable
    • price_max integer 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.