ショップ検索

概要

キーワードやフィルター条件でショップ情報を取得します。以下の機能をサポートします。

• あいまい検索に対応
• フィルターパラメータの設定が可能
• カスタムソート順に対応

API エンドポイント

POST /shop/v1/search

リクエストボディ

フィールド	型	必須	説明
keywords	string	いいえ	検索キーワード
filter	object	いいえ	フィルターパラメータ
orderby	array	いいえ	ソートパラメータ
page	integer	いいえ	ページ番号, デフォルト: 1
pagesize	integer	いいえ	1ページあたりの件数, デフォルト: 10

page * pagesize <= 5000

pagesize 範囲 [10, 100]

filter オプション値

フィールド	型	必須	説明
seller_name	string	いいえ	ショップ名
seller_id	string	いいえ	ショップID
creator_uid	string	いいえ	クリエイターUID
creator_unique_id	string	いいえ	クリエイターのユニークID : @xxxxxx
brand_name	string	いいえ	ブランド名
rating_range	object	いいえ	ショップ評価範囲, 例: {'min': 1, 'max': 5}
creator_range	object	いいえ	クリエイター数範囲, 例: {'min': 1, 'max': 123}
is_sshop	boolean	いいえ	フルマネージドショップかどうか
is_local	boolean	いいえ	ローカルショップかどうか
category_id	integer	いいえ	メインカテゴリ
region	string	いいえ	地域コード

利用可能な地域コード: ['US','GB','MX','ES','DE','IT','FR','PT','NL','BE','AT','PL','ID','VN','MY','TH','PH','BR','JP','SG']

orderby オプション値

フィールド	必須	説明
day7_units_sold	いいえ	7日間販売数（降順）
day7_gmv	いいえ	7日間売上（降順）
total_units_sold	いいえ	総販売数（降順）
total_gmv	いいえ	総売上（降順）

リクエスト例

curl 'https://openapi.fastmoss.com/shop/v1/search'' ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
    "keywords":"",
    "filter": {
        "region": "US",
        "seller_name": "xxxxx",
    },
    "orderby": [{
        "field": "day7_units_sold",
        "order": "desc"
    }],
    "page": 1,
    "pagesize": 10,
}'

レスポンスボディ

data.total

• 型: integer
• 説明: 結果の総数

data.list

フィールド	型	説明
seller_id	string	ショップID
category_id	array	商品カテゴリ
uid	string	UID
region	string	地域
name	string	ショップ名
brand	string	ブランド
shop_rating	integer	ショップ評価
total_units_sold	integer	総販売数
total_gmv	integer	総売上
day7_units_sold	integer	7日間販売数
day7_total_gmv	integer	7日間売上
is_local	integer	ローカルショップかどうか
is_sshop	integer	フルマネージドショップかどうか
on_sale_product_count	integer	販売中の商品数
affiliate_creator_count	integer	アフィリエイトクリエイター数

data.list.creator

フィールド	型	説明
uid	string	クリエイターUID
avatar	string	クリエイターアバター
region	string	クリエイター地域
nickname	string	クリエイターニックネーム
unique_id	string	クリエイターのユニークID
follower_count	integer	クリエイターのフォロワー数
category_id	integer	クリエイターのカテゴリID
category_name	string	クリエイターのカテゴリ名

レスポンス例

{
  "code": 0,
  "data": {
    "list": [
      {
        "seller_id": "7496169538916026807",
        "category_id": ["3", "839944"],
        "uid": "7502001270334194734",
        "region": "US",
        "name": "YOUNG",
        "brand": "",
        "shop_rating": 37,
        "total_units_sold": 0,
        "total_gmv": 0,
        "day7_units_sold": 0,
        "day7_total_gmv": 0,
        "is_local": 0,
        "is_sshop": 0,
        "on_sale_product_count": 1573,
        "affiliate_creator_count": 0,
        "creator": {
          "uid": "",
          "avatar": "",
          "region": "",
          "nickname": "",
          "unique_id": "",
          "follower_count": 0,
          "category_id": 0,
          "category_name": ""
        }
      }
    ],
    "total": 1
  },
  "message": "",
  "timestamp": 1744797551,
  "request_id": "6f12def3-6946-8c55-ef98-2c2b37af867e"
}