/paypayfleamarket/categories

POST /api/paypayfleamarket/categories

Price: 1 credit

Walk the Yahoo!フリマ (formerly PayPay フリマ) category tree one level at a time. Pass a parent category id to get its direct children, or 1 for the 21 top-level categories. The tree is four levels deep and the returned ids are exactly the values the category filter of the listing search accepts. Leaf categories also carry the product category the source maps them to.

How to use it

Resolve Yahoo!フリマ / PayPay フリマ category ids for the category_ids filter of paypayfleamarket/items/search. Start with category=1 for the top level (ファッション, ゲーム、おもちゃ, ...) and pass a returned id to go deeper, up to four levels. Each result has id, name (Japanese only), url, parent_id, is_leaf, is_wear_category (the level where clothing size and colour filters apply) and product_category. Asking for the children of a leaf category returns 412.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category integer — Parent category id whose direct children are returned; 1 is the top of the tree (default: 1; min: 1)
• count integer required — Max number of categories to return (examples: 50; min: 1)

Response

• @type string (default: "PaypayfleamarketCategory")
• id integer required
• name string required
• url string required
• parent_id integer required
• is_leaf boolean required
• is_wear_category boolean nullable
• is_purchase_prohibited_under_18 boolean nullable
• product_category object nullable
  • @type string (default: "PaypayfleamarketCategoryRef")
  • id integer required
  • name 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 — Category not found, or it is a leaf category with no children 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.