Skip to main content
POST
/sofmap/products/ranking

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
category_id
string
required
count
integer
required
Required range: 1 <= x <= 50
timeout
integer
default:300
Required range: 20 <= x <= 1500
period
enum<string>
default:weekly
Available options:
weekly,
monthly
scope
enum<string>
default:group
Available options:
group,
sofmap
product_type
enum<string>
default:all
Available options:
all,
new,
used
stock
enum<string> | null
Available options:
orderable,
in_stock,
new_product,
new_arrival

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