/yahoo_shopping/stores

POST /api/yahoo_shopping/stores

Price: 5 credits

Get a Yahoo! Shopping (Japan) store profile by alias (or store URL): name, description, rating, review count, total item count, logo image, open status, good-store badge, phone, and top store categories with their item counts.

How to use it

Fetch a single Yahoo!ショッピング (Yahoo! Shopping Japan) store by alias (e.g. 'mobilestation') or a full store URL. Returns one store with id/alias, name, description, rating, review_count, item_count, image (logo), is_open, badge_type, phone, url and categories (each with id/name/image/item_count).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• store string required — Yahoo! Shopping store as its alias or a full store URL (examples: "mobilestation", "https://store.shopping.yahoo.co.jp/mobilestation/"; minLength: 1)

Response

• @type string (default: "YahooShoppingStore")
• id string required
• alias string required
• name string nullable
• description string nullable
• rating number nullable
• review_count integer nullable
• item_count integer nullable
• image string nullable
• is_open boolean (default: false)
• badge_type integer nullable
• phone string nullable
• url string required
• categories array (default: [])
  • @type string (default: "YahooShoppingStoreCategory")
  • id string nullable
  • name string nullable
  • image string nullable
  • item_count integer 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 — Store not found (well-formed alias but the store does not exist or is closed) 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.