/paypayfleamarket/products/search

POST /api/paypayfleamarket/products/search

Price: 5 credits

Search the Yahoo!フリマ (formerly PayPay フリマ) product catalogue by name. Returns the canonical product entries with their catalogue id, specification text, JAN barcodes, brands and category path, which is how a product name is turned into the catalogue id used to list every second-hand offer of that exact product.

How to use it

Resolve a product name to a Yahoo!フリマ / PayPay フリマ catalogue id. Provide keyword and count. Each result has id (the catalogue id), url, name, description, image, jancodes, brands, product_category and category_path. min_price and model_number are only published on the single-product endpoint, so feed id into paypayfleamarket/products for the cheapest live offer, or into the catalog_ids filter of paypayfleamarket/items/search for every live listing of that product.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Product name to search the catalogue for (examples: "nintendo"; minLength: 1)
• count integer required — Max number of products to return (examples: 50; min: 1)

Response

• @type string (default: "PaypayfleamarketProduct")
• id string required
• url string required
• name string required
• description string nullable
• image string nullable
• images array (default: [])
• jancodes array (default: [])
• model_number string nullable
• min_price number nullable
• brands array (default: [])
  • @type string (default: "PaypayfleamarketBrandRef")
  • id integer required
  • name string required
• product_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
• is_ugc boolean nullable
• is_auction_listing_suggestion boolean 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.