/paypayfleamarket/items/search

POST /api/paypayfleamarket/items/search

Price: 5 credits

Search Yahoo!フリマ (formerly PayPay フリマ) listings across the whole marketplace filter surface: free-text keyword restricted to a single field if needed, category, brand, seller, product catalogue entry, hashtag, on-sale or sold state, declared condition, price range in yen, fashion facets (gender, clothing, shoe and kids sizes, how many times the item was worn, colour family), first-time listings, countdown-campaign listings, branded-only, suspected counterfeits excluded, bulk-purchase listings and listings native to Yahoo!フリマ against those cross-listed from Yahoo! Auctions. Each result carries the price and the price it was marked down from, condition, like count, category path, brand, hashtags and the seller's rating.

How to use it

Discover Yahoo!フリマ / PayPay フリマ listings for Japanese resale price research. At least one of keyword, category_ids, brand_ids, seller_ids, catalog_ids or hashtag must be given, plus count. Prices are Japanese yen. status is open (still on sale), sold or all; conditions are new, like_new, no_visible_damage, slight_damage and damaged; sort is ranking, open_time, price, like_count or end_time. Resolve category_ids with paypayfleamarket/categories, brand_ids with paypayfleamarket/brands/search and catalog_ids with paypayfleamarket/products/search. Each result has id, url, name, price, price_before_discount when the seller marked the item down, status, condition, image, like_count, opened_at/ended_at (unix seconds), category and category_path, brand, catalog_id, hashtags and seller. For view_count, the description and, on sold listings, how long the item took to sell, fetch the listing with paypayfleamarket/items.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• status string — Only listings that are still on sale, already sold, or both (default: "all"; one of: "open", "sold", "all")
• conditions array — Item conditions the seller declared (default: []; one of: "new", "like_new", "no_visible_damage", "slight_damage", "damaged")
• price_min integer nullable — Lowest asking price in Japanese yen (min: 0)
• price_max integer nullable — Highest asking price in Japanese yen (min: 0)
• sort string — Field the listings are ordered by (default: "ranking"; one of: "ranking", "open_time", "price", "like_count", "end_time")
• order string nullable — Direction of the ordering; best matches first for sort=ranking, newest or highest first (one of: "asc", "desc")
• gender array — Gender the fashion item is made for (default: []; one of: "mens", "womens", "boys", "girls")
• clothing_size array — Clothing sizes to include (default: []; one of: "2xs", "xs", "s", "m", "l", "xl", "2xl", "3xl", "4xl", "5xl", "6xl", "7xl", "8xl", "9xl", "free")
• shoe_size array — Shoe sizes to include (default: []; one of: "9cm", "9.5cm", "10cm", "10.5cm", "11cm", "11.5cm", "12cm", "12.5cm", "13cm", "13.5cm", "14cm", "14.5cm", "15cm", "15.5cm", "16cm", "16.5cm", "17cm", "17.5cm", "18cm", "18.5cm", "19cm", "19.5cm", "20cm", "20.5cm", "21cm", "21.5cm", "22cm", "22.5cm", "23cm", "23.5cm", "24cm", "24.5cm", "25cm", "25.5cm", "26cm", "26.5cm", "27cm", "27.5cm", "28cm", "28.5cm", "29cm", "29.5cm", "30cm", "30.5cm", "31cm", "31.5cm", "32cm", "32.5cm", "33cm", "33.5cm", "34cm", "free")
• kids_size array — Baby and kids clothing sizes to include (default: []; one of: "50cm", "60cm", "70cm", "80cm", "90cm", "95cm", "100cm", "110cm", "120cm", "130cm", "140cm", "150cm", "160cm", "170cm", "180cm", "free")
• wear_count array — How many times the seller says the item was worn (default: []; one of: "once_or_twice", "three_to_five", "six_to_ten", "eleven_or_more")
• color array — Colour families to include (default: []; one of: "white", "black", "gray", "beige", "brown", "red", "pink", "purple", "navy", "blue", "green", "khaki", "yellow", "orange", "gold", "silver", "clear", "multi")
• keyword string — Free-text search phrase (default: ""; examples: "ニンテンドー")
• query_target string nullable — Which parts of the listing the free-text phrase must match instead of matching anywhere (one of: "name", "description", "category_name", "brand_name", "name_description_brand_or_category")
• category_ids array — Narrow the search to these categories, at any depth of the tree, with ids from paypayfleamarket/categories; the source treats them as a scope for its relevance ranking, so a small share of the results can come from an adjacent category (default: []; examples: [2511])
• brand_ids array — Brand ids from paypayfleamarket/brands/search (default: [])
• seller_ids array — Only listings from these sellers (default: [])
• catalog_ids array — Only listings of these product catalogue entries (default: [])
• hashtag string — Only listings carrying this hashtag (default: ""; examples: "ちいかわ")
• first_submit boolean nullable — Only a seller's very first listing
• count_down_campaign boolean nullable — Only listings taking part in the countdown bonus campaign
• has_brand boolean nullable — Only listings that have a brand assigned
• except_suspected_fake boolean nullable — Drop listings the source flags as suspected counterfeits
• include_bulk boolean nullable — Include listings offered for bulk purchase
• sparkle_submit boolean nullable — True keeps only listings created on Yahoo!フリマ itself, false only those cross-listed from Yahoo! Auctions; matches is_sparkle_submit on the results
• count integer required — Max number of listings to return (examples: 100; min: 1)

Response

• @type string (default: "PaypayfleamarketItemCard")
• id string required
• url string required
• name string required
• price number nullable
• price_before_discount number nullable
• status string nullable
• condition string nullable
• condition_name string nullable
• image string nullable
• image_count integer nullable
• like_count integer nullable
• opened_at integer nullable
• ended_at integer nullable
• category object nullable
  • @type string (default: "PaypayfleamarketCategoryRef")
  • id integer required
  • name string required
• category_path array (default: [])
  • @type string (default: "PaypayfleamarketCategoryRef")
  • id integer required
  • name string required
• category_url string nullable
• product_category_id integer nullable
• brand object nullable
  • @type string (default: "PaypayfleamarketBrandRef")
  • id integer required
  • name string required
• catalog_id string nullable
• hashtags array (default: [])
• seller object nullable
  • @type string (default: "PaypayfleamarketUserRef")
  • id string required
  • url string required
  • rating_count integer nullable
  • good_ratio number nullable
• is_price_down boolean nullable
• is_first_submit boolean nullable
• is_sparkle_submit boolean nullable
• is_count_down_campaign_target boolean nullable
• is_bulk_purchase_item boolean nullable

Errors

• 422 — No search scope given (keyword, category_ids, brand_ids, seller_ids, catalog_ids or hashtag) 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.