Skip to main content
POST
/sofmap/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: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
keyword
string | null
Minimum string length: 1
exclude_keyword
string | null
Minimum string length: 1
category_id
string | null
product_type
enum<string>
default:all
Available options:
all,
new,
used
used_rank
enum<string>[] | null
Available options:
S,
A,
B,
C,
D,
E
maker
string[] | null
color
enum<string>[] | null
Available options:
black,
white,
gray,
silver,
blue,
green,
beige,
yellow,
gold,
orange,
brown,
red,
pink,
purple,
clear,
other
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
stock
enum<string> | null
Available options:
orderable,
in_stock,
new_product,
new_arrival
specs
string[] | null
sort
enum<string>
default:recommended
Available options:
recommended,
sales,
price_asc,
price_desc,
name,
maker,
release_date_desc,
release_date_asc

Response

Successful Response

url
string
required
@type
string
default:SofmapProductCard
id
string | null
name
string | null
brand
string | null
image
string | null
jan
string | null
price
number | null
currency
string
default:JPY
is_price_from
boolean
default:false
point
integer | null
release_date
string | null
release_date_text
string | null
stock_status
string | null
stock_message
string | null
is_sold_out
boolean
default:false
is_used
boolean
default:false
used_rank
enum<string> | null
Available options:
S,
A,
B,
C,
D,
E
used_count
integer | null
store
object | null
badges
string[]
rating
number | null
review_count
integer | null
review_url
string | null
rank
integer | null
rank_change
string | null