ショップアフィリエイト

概要

seller_id を使用して、ショップをプロモーションしているアフィリエイトを取得します。

エンドポイント

POST /shop/v1/creatorList

リクエストボディ

フィールド	型	必須	説明
filter	object	いいえ	フィルターパラメータ
orderby	object	いいえ	ソートパラメータ
page	integer	いいえ	デフォルト: 1
pagesize	integer	いいえ	デフォルト: 10

filter オプション値

フィールド	型	必須	説明
seller_id	string	いいえ	ショップID
creator_uid	string	いいえ	ショップに関連するクリエイターUID
creator_unique_id	string	いいえ	ショップに関連するユニーククリエイターID: @xxxxxxx
seller_name	string	いいえ	ショップ名
region	string	いいえ	ショップの国/地域

seller_name と region は同時に指定する必要があります

orderby オプション値

フィールド	必須	説明
digg_count	いいえ	いいね数
follower_count	いいえ	フォロワー数
units_sold	いいえ	販売数
gmv	いいえ	売上金額（GMV）

リクエスト例

curl 'https://openapi.fastmoss.com/shop/v1/creatorList' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
    "filter": {
        "seller_id": "7495500842223700917",
        # "creator_uid": "xxxxxxxxxxx",
        # "creator_unique_id": "xxxxxxx",
        # "seller_name": "xxxxxx",
        # "region": "US"
    },
    "orderby": [{
        "field": "units_sold",
        "order": "desc"
    }],
    # "orderby": [{
    #     "field": "gmv",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "follower_count",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "digg_count",
    #     "order": "desc"
    # }],
    "page": 1,
    "pagesize": 10
}'

レスポンスボディ

data.total

結果の総数

data.list

フィールド	型	説明
uid	string	クリエイターUID
seller_id	string	ショップID
unique_id	string	クリエイターのユニークID
nickname	string	クリエイターのニックネーム
avatar	string	クリエイターのアバターURL
units_sold	integer	クリエイター販売数
gmv	float	クリエイターGMV
category_id	integer	クリエイターカテゴリID
category_name	string	クリエイターカテゴリ名
follower_count	integer	クリエイターのフォロワー数
aweme_count	integer	クリエイターの動画数
favoriting_count	integer	クリエイターのいいね獲得数
region	string	クリエイターの地域

レスポンス例

{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 8,
    "list": [
      {
        "uid": "6893103660525831169",
        "seller_id": "xxxxxxxxxxxx",
        "units_sold": 1354,
        "gmv": 22034.60,
        "unique_id": "twobakeboys",
        "nickname": "Twobakeboys",
        "avatar": "https://s.500fd.com/tt_author/935c7d720caecc448ed85fbcbac1218b~c5_300x300.jpeg",
        "category_id": 5, //creator's category_id
        "category_name": "Food & Beverage", //creator's category_name
        "category": [//deprecated
            "Food & Beverage"
        ],
        "follower_count": 22572,
        "aweme_count": 510,
        "favoriting_count": 480,
        "region": "SG" //creator's region
      }
     ]
 }
}