商品ランキング - 売上トップ
概要
売上トップの商品を取得します。以下の機能をサポートします。
- フィルターパラメータの設定が可能
- カスタムソート順に対応
API エンドポイント
bash
POST /product/v1/rank/topSellingリクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
filter | object | いいえ | フィルターパラメータ |
orderby | object | いいえ | ソートパラメータ |
page | integer | いいえ | ページ番号, デフォルト: 1 |
pagesize | integer | いいえ | 1ページあたりの件数, デフォルト: 10 |
page*pagesize<= 500
pagesize範囲 [1, 100]
filter オプション値
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
region | string | いいえ | 国/地域 |
category_id | integer | いいえ | 商品カテゴリ |
date_info | object | はい | 日付情報, 例: {'type': 'day', 'value': '2026-02-01'} |
利用可能な地域:
['US', 'ID', 'GB', 'VN', 'TH', 'MY', 'PH', 'SG', 'ES', 'MX', 'DE', 'FR', 'PT', 'NL', 'BE', 'AT', 'PL', 'IT', 'BR', 'JP']
orderby オプション値
| フィールド | 必須 | 説明 |
|---|---|---|
units_sold | いいえ | 販売数(降順) |
gmv | いいえ | 売上(降順) |
total_units_sold | いいえ | 総販売数(降順) |
total_gmv | いいえ | 総売上(降順) |
growth_rate | いいえ | 成長率(降順) |
リクエスト例
bash
curl 'https://openapi.fastmoss.com/product/v1/rank/topSelling' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
"filter": {
"region": "US",
"category_id": 2,
"date_info": {
"type": "day",
"value": "2026-02-01"
},
# "date_info": {
# "type": "week",
# "value": "2026-18"
# },
# "date_info": {
# "type": "month",
# "value": "2026-02"
# }
},
"orderby": [
{
"field": "gmv",
"order": "desc"
}
],
"page": 1,
"pagesize": 10
}'レスポンスボディ
data.total
- 型: integer
- 説明: 結果の総数
data.list
| フィールド | 型 | 説明 |
|---|---|---|
product_id | string | 商品ID |
title | string | 商品タイトル |
region | string | 国/地域 |
cover | string | 商品カバーURL |
category | object | 商品カテゴリ |
commission_rate | integer | コミッション率 |
real_price | string | 商品価格 |
units_sold | integer | 販売数 |
gmv | integer | 売上 |
total_units_sold | integer | 総販売数 |
total_gmv | integer | 総売上 |
growth_rate | integer | 販売成長率 |
shop | object | ショップ情報 |
data.list.shop
| フィールド | 型 | 説明 |
|---|---|---|
seller_id | string | ショップID |
name | string | ショップ名 |
avatar | string | ショップカバーURL |
total_units_sold | integer | ショップ総販売数 |
レスポンス例
json
{
"code": 0,
"msg": "success",
"data": {
"total": 500,
"list": [
{
"product_id": "1729537665891078575",
"title": "33.81oz Glass Water Cup, Large Glass Cup with Lid & Straw, Drinking Cup for Home Office Use, Drinkware Gift Ideas, Kitchen Accessories",
"cover": "https://s.500fd.com/tt_product/16e26aec1fb94e3784665b5b2ecfe0e0~tplv-dx0w9n1ysr-resize-jpeg:800:800.jpeg",
"real_price": "$10.94",
"region": "US",
"commission_rate": 1234,
"category": {
"l1": { "id": 123, "name": "test" }
},
"units_sold": 123,
"gmv": 123,
"total_units_sold": 123,
"total_gmv": 123,
"growth_rate": 123,
"shop": {
"seller_id": 123,
"name": "test",
"avatar": "xxx",
"total_units_sold": 123
}
}
]
}
}