You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/菜单管理/UpdateProductOutOfStock - 更新商品卡片的售罄状态
UpdateProductOutOfStock - 更新商品卡片的售罄状态
最近更新时间：2025.09.26 16:21:04首次发布时间：2025.09.26 10:48:16
复制全文
我的收藏
有用
有用
无用
无用

调用 UpdateProductOutOfStock 接口，更新直播间内已有商品卡片的售罄状态。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ActivityId

Integer

是

1779853970487296

直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

说明

使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

ProductIdsArray of Integer是[492046]商品卡片 ID 列表。调用 GetActivityProducts 接口，根据返回参数 Id 获取商品卡片 ID。

OutOfStock

Integer

是

0

是否售罄传入的商品卡片对应的所有商品。商品售罄后，观看页的商品图和跳转图将展示“已抢光”的文案。取值如下：

  • 0：未售罄
  • 1：已售罄

注意

若商品价格为隐藏状态，则不支持售罄商品。您可调用 GetActivityProducts 接口，获取商品价格是否为隐藏状态。调用 HideProductPrice 接口，更新商品价格的隐藏状态。

返回参数

参数类型示例值描述

Status

Boolean

true

是否更新成功。取值如下：

  • true：成功
  • false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateProductOutOfStock&Version=2023-08-01
{
    "ActivityId": 17791682871580,
    "ProductIds": [
        492046
    ],
    "OutOfStock": 1
}

返回示例

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

错误码

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