クリエイターのプロモーション商品

概要

クリエイターの uid を使用して、そのクリエイターがプロモーションしている商品を取得します。

エンドポイント

POST /creator/v1/productList

リクエストボディ

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

filter オプション

フィールド	型	必須	説明
uid	string	はい	クリエイターUID
days	string	いいえ	期間, 例: [0, 7, 14, 28, 90]

orderby オプション

フィールド	必須	説明
units_sold	いいえ	商品の販売数（降順）
gmv	いいえ	商品のGMV（降順）
commission_rate_percent	いいえ	コミッション率（降順）

orderby 形式: {"field": "units_sold", "order": "desc"}。指定しない場合、安定したページングのため product_id（降順）で並び替えられます。

リクエスト例

curl 'https://openapi.fastmoss.com/creator/v1/productList' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
    "filter": {
        "uid": "6893103660525831169",
        "days": 7
    },
    "orderby": {
        "field": "units_sold",
        "order": "desc"
    },
    # "orderby": {
    #     "field": "gmv",
    #     "order": "desc"
    # },
    # "orderby": {
    #     "field": "commission_rate_percent",
    #     "order": "desc"
    # },
    "page": 1,
    "pagesize": 10
}'

レスポンスボディ

data.total

結果の総数

data.list

フィールド	型	説明
product_id	string	商品ID
uid	string	クリエイターUID
seller_id	string	セラーID
commission_rate	integer	コミッション率
product_rating	string	商品評価
shop_title	string	ショップ名
shop_avatar	string	ショップアバターURL
shop_units_count	integer	ショップ販売数
shop_gmv	float	ショップGMV
title	string	商品タイトル
cover	string	商品カバーURL
category	array[object]	商品カテゴリ
real_price	string	商品価格
region	string	商品の地域
gmv	float	商品GMV
units_sold	integer	商品販売数
l1_category_id	integer	カテゴリレベル1 ID
l2_category_id	integer	カテゴリレベル2 ID
l3_category_id	integer	カテゴリレベル3 ID

レスポンス例

{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 8,
    "list": [
      {
        "product_id": "1729539239170312086",
        "uid": "6893103660525831169",
        "seller_id": "7494962456968727446",
        "commission_rate": 0,
        "product_rating": "0.0",
        "shop_title": "Twobakeboys",
        "shop_avatar": "https://s.500fd.com/tt_shop/6413a6ce066e4108a30e50d1033dac88~tplv-aphluv4xwc-resize-png:300:300.png",
        "shop_units_count": 23867,
        "shop_gmv": 607576.80,
        "title": "Pineapple tart 230g per bottle",
        "cover": "https://s.500fd.com/default/product_default.png",
        "category": [
            "Food & Beverages"
        ],
        "real_price": "S$15.00",
        "region": "SG",//product's region
        "gmv": 0,
        "units_sold": 0,
        "l1_category_id":24,//product's l1 category_id
        "l2_category_id":915336,//product's l2 category_id
        "l3_category_id":700553//product's l3 category_id
      }
     ]
 }
}