/rakuma/users

POST /api/rakuma/users

Price: 10 credits

Get a Rakuma (fril.jp) seller profile by shop id or shop URL: shop and user names, whether the seller is a private individual or a business, self-written profile text, avatar and cover images, identity-verification badge, average transaction rating with its review count, how many listings the shop currently has, and the brands and categories the seller trades in plus their favourite brands.

How to use it

Fetch a Rakuma seller profile by 32-hex shop id or fril.jp/shop URL. Returns id, internal_id, name, shop_name, seller_type (一般 individual / 事業者 business, same vocabulary as on items and cards), bio, image, cover, is_verified, rating, rating_count, item_count, handled_brands, handled_categories, favorite_brands and url. Search results expose only the numeric seller_id, which is not the hex shop id — take the hex id from rakuma/items (seller.id). Use rakuma/users/items for the inventory and rakuma/users/reviews for the feedback.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — Rakuma shop id (32 hex characters) or shop URL (examples: "cd3740fcb59f2bcd8ed141125a8bd206", "https://fril.jp/shop/cd3740fcb59f2bcd8ed141125a8bd206"; minLength: 1)

Response

• @type string (default: "RakumaUser")
• id string required
• internal_id integer nullable
• name string nullable
• shop_name string nullable
• seller_type string nullable
• bio string nullable
• image string nullable
• cover string nullable
• is_verified boolean (default: false)
• rating number nullable
• rating_count integer nullable
• item_count integer nullable
• handled_brands array (default: [])
  • @type string (default: "RakumaBrandRef")
  • id integer required
  • name string nullable
  • url string nullable
• handled_categories array (default: [])
  • @type string (default: "RakumaCategoryRef")
  • id integer nullable
  • name string nullable
  • url string nullable
• favorite_brands array (default: [])
  • @type string (default: "RakumaBrandRef")
  • id integer required
  • name string nullable
  • url string nullable
• url string 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 — Seller not found (well-formed id with no Rakuma shop) 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.