/yahoo/auctions/sellers/items

POST /api/yahoo/auctions/sellers/items

Price: 20 credits

List the live Yahoo! Auctions Japan (Yahoo!オークション) listings of one seller, with filters for keyword, excluded words, category, price range, item condition, shipping-from prefecture, brand, free shipping and photo presence, plus sorting by recency, remaining time, price, buy-it-now price, bid count, popularity or featured rank. Returns full listing cards with price, buy-it-now price, start price, bid and watch counts, end time, condition, category path, brand, region and seller.

How to use it

List a Yahoo! Auctions Japan seller's currently running listings — use it to monitor a competitor's or a shop's inventory. Provide seller (the opaque id from /seller/{id}) and count; optionally keyword, keyword_exclude, category, price_min/price_max, condition, region, brand_id, free_shipping, has_image and sort. Each result has id, url, name, image, price, buy_now_price, start_price, bid_count, watch_count, start_at/end_at (unix seconds), condition, category, category_path, brand_id, region, marketplace, is_taxed and seller. price and buy_now_price include consumption tax; start_price is the pre-tax opening bid.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category integer nullable — Category id to search in, as returned by yahoo/auctions/categories (min: 0)
• price_min integer nullable — Minimum price (JPY) (min: 0)
• price_max integer nullable — Maximum price (JPY) (min: 0)
• condition string nullable — Item condition (one of: "new", "used", "like_new", "no_visible_damage", "slight_damage", "damaged", "poor")
• region string nullable — Prefecture the item is shipped from (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "yamanashi", "nagano", "niigata", "toyama", "ishikawa", "fukui", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa", "overseas")
• brand_id integer nullable — Brand id, as returned in item brand_id (min: 0)
• free_shipping boolean — Only items shipped free of charge (default: false)
• has_image boolean — Only items that have a photo (default: false)
• seller string required — Yahoo! Auctions Japan seller id or a full seller page URL (examples: "2WZF25HbH5hVYuP5xt9wEg1CArvMM"; minLength: 1)
• keyword string nullable — Keyword to search within the seller's listings
• keyword_exclude string nullable — Space-separated words that must not appear in the item name
• sort string — Sort order (default: "newest"; one of: "newest", "ending_soonest", "ending_latest", "price_asc", "price_desc", "buy_now_price_asc", "buy_now_price_desc", "bids_desc", "bids_asc", "popular", "featured")
• count integer required — Max number of results to return (examples: 20; min: 1)

Response

• @type string (default: "YahooAuctionsItemCard")
• id string required
• url string required
• name string required
• image string nullable
• price integer nullable
• buy_now_price integer nullable
• start_price integer nullable
• is_taxed boolean nullable
• bid_count integer nullable
• watch_count integer nullable
• start_at integer nullable
• end_at integer nullable
• condition string nullable
• category object nullable
  • @type string (default: "YahooAuctionsCategoryRef")
  • id string required
  • name string required
• category_path array (default: [])
  • @type string (default: "YahooAuctionsCategoryRef")
  • id string required
  • name string required
• brand_id integer nullable
• region string nullable
• region_code integer nullable
• marketplace string nullable
• is_fixed_price boolean nullable
• is_free_shipping boolean nullable
• is_new_arrival boolean nullable
• is_appraisal boolean nullable
• is_featured boolean nullable
• seller object nullable
  • @type string (default: "YahooAuctionsSeller")
  • id string required
  • url string required
  • display_name string nullable
  • image string nullable
  • rating_count integer nullable
  • good_rating number nullable
  • is_store boolean nullable
  • is_best_store boolean nullable
  • is_excellent_seller boolean nullable
  • is_verified boolean nullable
  • is_speed_shipping boolean nullable
  • region string nullable
  • region_code integer nullable
  • profile_message string nullable
  • store_licenses array (default: [])
    • @type string (default: "YahooAuctionsStoreLicense")
    • name string required
    • code 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 — 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.