Skip to main content
POST
/surugaya/products/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: 1 <= x <= 9984
timeout
integer
default:300
Required range: 20 <= x <= 1500
keyword
string | null
Minimum string length: 1
exclude_keyword
string | null
Minimum string length: 1
product_title
string | null
Minimum string length: 1
category_id
string | null
condition
enum<string> | null
Available options:
new,
used,
preorder
brand
string | null
genre
string | null
hardware_type
string | null
store_id
string | null
trend
enum<string> | null
Available options:
rising,
price_drop,
new_arrival
seller_scope
enum<string> | null
Available options:
marketplace,
surugaya
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
price_ratio_min
integer | null
Required range: x >= 0
price_ratio_max
integer | null
Required range: x >= 0
release_year_min
integer | null
Required range: 1900 <= x <= 2200
release_year_max
integer | null
Required range: 1900 <= x <= 2200
isbn
string | null
model_number
string | null
include_out_of_stock
boolean
default:false
sort
enum<string>
default:relevance
Available options:
relevance,
price_asc,
price_desc,
updated,
release_date_desc,
release_date_asc

Response

Successful Response

id
string
required
url
string
required
@type
string
default:SurugayaProductCard
name
string | null
image
string | null
product_type
string | null
brand
string | null
release_date
string | null
prices
object[]
price
number | null
list_price
number | null
currency
string
default:JPY
is_sold_out
boolean
default:false
is_new_arrival
boolean
default:false
marketplace_price
number | null
marketplace_offer_count
integer | null
marketplace_offer_label
string | null