/paypayfleamarket/products

POST /api/paypayfleamarket/products

Price: 1 credit

Get a Yahoo!フリマ (formerly PayPay フリマ) product catalogue entry by its id or URL: the canonical product name, the structured specification text, JAN barcodes, the manufacturer model number, brands, the product and genre category path, and the lowest price the product is currently offered at on the marketplace. The catalogue id is the bridge between second-hand listings of the same product and retail barcode data.

How to use it

Fetch a Yahoo!フリマ / PayPay フリマ product catalogue entry by catalogue id (e.g. '7558c5bdd2') or product URL, for price tracking against a barcode. Returns name, description (specification lines), image/images, jancodes (JAN/EAN barcodes), model_number (the manufacturer part number, when the catalogue records one), min_price in Japanese yen, brands, product_category and category_path. Pass the same id as catalog_ids to paypayfleamarket/items/search to list every live listing of that product; resolve a product name to an id with paypayfleamarket/products/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Yahoo!フリマ product catalogue id or a full product URL (examples: "7558c5bdd2", "z43iq3o5bl", "https://paypayfleamarket.yahoo.co.jp/product/7558c5bdd2"; minLength: 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 — Product not found (well-formed catalogue id but no such product on Yahoo!フリマ) 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.