调用 HideProductPrice 接口,更新直播间内已有商品卡片售卖价格的隐藏状态。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | HideProductPrice | 接口名称。当前 API 的名称为 HideProductPrice。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Integer | 是 |
| 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| ProductIds | Array of Integer | 是 | [492046] | 商品卡片 ID 列表。调用 GetActivityProducts 接口,根据返回参数 Id获取商品卡片 ID。 |
PriceHidden | Integer | 是 |
| 是否隐藏商品售卖价格。商品价格隐藏后,观看页的商品售卖价将以“待开价¥???”的文案展示。取值如下:
注意 若商品为售罄状态,则不支持隐藏商品的售卖价格。您可调用 GetActivityProducts 接口,获取商品是否为售罄状态。调用 UpdateProductOutOfStock 接口,更新商品的售罄状态。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Status | Boolean |
| 是否更新成功。取值如下:
|
POST https://livesaas.volcengineapi.com/?Action=HideProductPrice&Version=2023-08-01 { "ActivityId": 17791682871580, "ProductIds": [ 492046 ], "PriceHidden": 1 }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "HideProductPrice", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Status": true } }