/paypayfleamarket/brands

POST /api/paypayfleamarket/brands

Price: 1 credit

Get a Yahoo!フリマ (formerly PayPay フリマ) brand by its id: the display name plus the Japanese kana and the romanised English readings the marketplace indexes it under.

How to use it

Look up a Yahoo!フリマ / PayPay フリマ brand by numeric id (e.g. 115415). Returns id, name, name_kana and name_english. To go the other way, from a brand name to an id usable in the brand_ids filter of paypayfleamarket/items/search, use paypayfleamarket/brands/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• brand integer required — Yahoo!フリマ brand id (examples: 115415; min: 1)

Response

• @type string (default: "PaypayfleamarketBrand")
• id integer required
• name string required
• name_kana string nullable
• name_english string nullable
• has_children 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 — Brand not found (well-formed id but no such brand 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.