ショップ関連ライブ配信リスト

概要

指定したショップに関連するライブ配信リストデータを取得します。

エンドポイント

    POST /shop/v1/liveList

リクエストボディ

フィールド	型	必須	説明
filter	object	いいえ	フィルターパラメータ
orderby	array	いいえ	ソートパラメータ
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 オプション値

フィールド	必須	説明
start_time	いいえ	開始時間
product_count	いいえ	ライブルームの商品数
total_user_count	いいえ	総視聴者数
units_sold	いいえ	販売数
gmv	いいえ	売上金額（GMV）

リクエスト例

curl 'https://openapi.fastmoss.com/shop/v1/liveList' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
    "filter": {
        "seller_id": "7495500842223700917",
        # "creator_uid": "6913013214088004614",
        # "creator_unique_id": "caffeinecandleschaos",

        # "seller_name": "Caffeine, Candles & Chaos",
        # "region": "US",
    },
    "orderby": [{
        "field": "start_time",
        "order": "desc"
    }],
    # "orderby": [{
    #     "field": "product_count",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "total_user_count",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "units_sold",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "gmv",
    #     "order": "desc"
    # }],
    "page": 1,
    "pagesize": 10
}'

レスポンスボディ

data.list

フィールド	型	説明
title	string	ライブルームのタイトル
room_id	string	ライブルームID
seller_id	string	ショップID
uid	string	ショップに関連するクリエイターUID
cover	string	カバー画像URL
main_category_name	string	メインプロモーションカテゴリ名
main_category_id	int	メインプロモーションカテゴリID
start_time	int	開始時間
units_sold	int	販売数
gmv	float	売上金額（GMV）
product_count	int	ライブルームの商品数
total_user	int	総視聴者数
duration	int	ライブ配信時間（秒）
max_user_count	int	最大同時視聴者数
inc_follower_count	int	フォロワー増加数
share_count	int	シェア数
is_live	int	現在配信中かどうか
live_type	int	ライブタイプ 1: ショップライブ 2: 個人ライブ
creator	object	関連クリエイター情報

data.list.creator

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

data.total

フィールド	型	説明
total	string	総レコード数

レスポンス例

{
  "code": 0,
  "data": {
    "total": 11943,
    "list": [
      {
        "title": "Food and snacks",
        "room_id": "7539139975317703438",
        "cover": "https://s.500fd.com/tt_live/7411364270883588910~tplv-obj.image",
        "main_category_id": 24,
        "main_category_name": "Food & Beverages",
        "creator": {
          "uid": "73083231876554752",
          "avatar": "https://s.500fd.com/tt_author/5aa17bc74b4fd2b91ae364d2a2c6e4d6~tplv-tiktokx-cropcenter:1080:1080.jpeg",
          "region": "US",
          "nickname": "Courtney Luper 🗝️✨",
          "unique_id": "courtneyluper",
          "follower_count": 17183,
          "category_id": 5,
          "category_name": "Food & Beverage"
        },
        "start_time": 1755343248,
        "units_sold": 1939,
        "gmv": 4253.69,
        "product_count": 99,
        "total_user": 84333,
        "duration": 37159,
        "max_user_count": 430,
        "inc_follower_count": 243,
        "share_count": 188,
        "is_live": 0,
        "live_type": 2
      }
    ]
  },
  "message": "success",
  "timestamp": 1773751121,
  "request_id": "76d984e2-e0f8-d04c-dc2d-c1fc9a18ffda"
}