Skip to main content
POST
/yahoo/auctions/items/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
category
integer | null
Required range: x >= 0
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
condition
enum<string> | null
Available options:
new,
used,
like_new,
no_visible_damage,
slight_damage,
damaged,
poor
region
enum<string> | null
Available options:
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 | null
Required range: x >= 0
free_shipping
boolean
default:false
has_image
boolean
default:false
keyword
string | null
keyword_exclude
string | null
buy_now_price_min
integer | null
Required range: x >= 0
buy_now_price_max
integer | null
Required range: x >= 0
seller_type
enum<string> | null
Available options:
store,
individual
listing_type
enum<string> | null
Available options:
auction,
fixed_price
marketplace
enum<string> | null
Available options:
yahoo_auctions,
yahoo_flea
authenticated
boolean
default:false
new_arrival
boolean
default:false
ending_within_hour
boolean
default:false
konbini_pickup
boolean
default:false
anonymous_shipping
boolean
default:false
sort
enum<string>
default:newest
Available options:
newest,
ending_soonest,
ending_latest,
price_asc,
price_desc,
buy_now_price_asc,
buy_now_price_desc,
bids_desc,
bids_asc,
popular,
featured

Response

Successful Response

id
string
required
url
string
required
name
string
required
@type
string
default:YahooAuctionsSearchItem
image
string | null
price
integer | null
buy_now_price
integer | null
start_price
integer | null
bid_count
integer | null
end_at
integer | null
category_id
string | null
category_path_ids
string[]
marketplace
string | null
is_free_shipping
boolean | null
accepts_easy_payment
boolean | null
seller_id
string | null
seller_url
string | null