You need to enable JavaScript to run this app.
导航
更新商品的热卖或库存提醒
最近更新时间:2025.01.03 10:57:39首次发布时间:2025.01.03 10:57:39

在商品讲解期间,调用 UpdateProductReminderInfo 接口更新商品的热卖或库存提醒,可以在浮窗商品卡片和商品卡片菜单中,动效展示该商品的热卖或库存情况,促进下单。

使用说明

为确保观看页能够展示更新的热卖或库存提醒,必须同时满足以下条件:

  • 已启用商品卡片菜单。您可通过调用 ModifyActivityMenus 接口,启用商品卡片菜单。
  • 已上架商品卡片。您可调用 UpdateActivityProduct 接口,将 EnableStatus 的参数值设置为 1,上架商品卡片。
  • 已对商品卡片标记商品讲解。您可调用 ExplainProduct 接口,将 ExplainStatusFloatingStatus 的参数值设置为 1,标记商品讲解。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 使用限制:目前仅支持在移动端展示商品的热卖和库存提醒。

请求说明

  • 请求方式:POST
  • 请求地址:https://livesaas.volcengineapi.com/?Action=UpdateProductReminderInfo&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringUpdateProductReminderInfo接口名称。当前 API 的名称为 UpdateProductReminderInfo
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

Body

参数类型是否必选示例值描述
ActivityIdLong177****9762直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
ProductIdLong8****6商品卡片 ID。您可通过调用 GetActivityProducts 接口获取 ID。

ReminderType

Integer

1

提醒类型。取值如下:

  • 0:无
  • 1:热卖
  • 2:库存

HotSale

String

1000

热卖提醒数量。长度为 1 到 5 个字符。

说明

当 ReminderType 取值为 1 时,该参数生效。

Stock

String

50

库存提醒数量。长度为 1 到 2 个字符。

说明

当 ReminderType 取值为 2 时,该参数生效。

返回参数

参数类型示例值描述
StatusBooleantrue是否成功更新热卖或库存提醒。成功返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateProductReminderInfo&Version=2023-08-01
{
    "ActivityId": 177****9762,
    "ProductId": 8****6,
    "ReminderType": 1,
    "HotSale": "1000",
    "Stock": "50"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateProductReminderInfo",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

访问公共错误码错误码获取详细信息。