Shop Affiliates

Introduction

Get affiliates promoting a shop using the seller_id.

Endpoint

POST /shop/v1/creatorList

Request Body

Field	Type	Required	Description
filter	object	No	Filter parameters
orderby	object	No	Sorting parameters
page	integer	No	Default: 1
pagesize	integer	No	Default: 10

filter Optional Values

Field	Type	Required	Description
seller_id	string	No	Shop ID
creator_uid	string	No	Creator UID associated with the shop
creator_unique_id	string	No	Unique Creator ID associated with the shop: @xxxxxxx
seller_name	string	No	Shop Name
region	string	No	Country/Region of the shop

seller_name and region must be passed at the same time

orderby 可选值

Field	Required	Description
digg_count	No	digg count
follower_count	No	follower count
units_sold	No	Sales Volume
gmv	No	Sales Amount (GMV)

Request Example

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
}'

Response Body

data.total

Total number of results

data.list

Field	Type	Description
uid	string	Creator UID
seller_id	string	Shop ID
unique_id	string	Creator Unique ID
nickname	string	Creator Nickname
avatar	string	Creator Avatar URL
units_sold	integer	Creator Sales
gmv	float	Creator GMV
category_id	integer	Creator Category ID
category_name	string	Creator Category Name
follower_count	integer	Creator Follower Count
aweme_count	integer	Creator Video Count
favoriting_count	integer	Creator Favoriting Count
region	string	Creator Region

Response Example

{
  "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
      }
     ]
 }
}