# 获取限时抢购任务列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getlimiteddiscounttasklist
可通过该接口获取限时抢购任务
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/product/limiteddiscounttask/list/get?access_token=ACCESS_TOKEN
# 云调用
调用方法:channels.ec.product.limiteddiscounttask.list.get
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档。
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用) |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| status | number | 否 | 指定获取某个status状态下的限时抢购任务列表,如果不填,则获取所有状态下的限时抢购任务列表 | 枚举值 |
| page_size | number | 是 | 每页数量(默认10,不超过50) | - |
| next_key | string | 否 | 由上次请求返回,记录翻页的上下文,传入时会从上次返回的结果往后翻一页,不传默认获取第一页数据 | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| limited_discount_tasks | objarray | 限时抢购信息 |
| next_key | string | 本次翻页的上下文,用于请求下一页 |
| total_num | number | 商品总数 |
# Res.limited_discount_tasks(Array) Object Payload
限时抢购信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| task_id | string | 限时抢购任务ID |
| product_id | string | 抢购商品ID |
| status | number | 限时抢购任务状态 |
| create_time | number | 限时抢购任务创建时间(秒级时间戳) |
| start_time | number | 限时抢购任务开始时间(秒级时间戳) |
| end_time | number | 限时抢购任务结束时间(秒级时间戳) |
| limited_discount_skus | objarray | limited_discount_skus |
# Res.limited_discount_tasks(Array).limited_discount_skusObject Payload
Object Payloadlimited_discount_skus
| 参数名 | 类型 | 说明 |
|---|---|---|
| sku_id | string | 限时抢购任务下不同的sku_id |
| sale_price | number | 该sku_id的抢购价格 |
| sale_stock | number | 该sku_id设置的抢购数量 |
# 4. 枚举信息
# Body.status Enum
指定获取某个status状态下的限时抢购任务列表,如果不填,则获取所有状态下的限时抢购任务列表
| 枚举值 | 描述 |
|---|---|
| 0 | 限时抢购任务创建完成,未开始,此时不能直接调用删除接口 |
| 1 | 限时抢购任务进行中,此时不能直接调用删除接口 |
| 2 | 限时抢购任务已结束 |
# 5. 注意事项
本接口已重新上线,限时抢购任务状态status字段含义有修改,可参考枚举值status限时抢购任务状态,请仔细阅读。
# 6. 代码示例
请求示例
{
"status": 0,
"page_size": 10,
"next_key": "THE_NEXT_KEY"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"limited_discount_tasks": [
{
"task_id": "12345677",
"product_id": "12345678001",
"status": 0,
"create_time": 1660047026,
"start_time": 1660046940,
"end_time": 1662293399,
"limited_discount_skus": [
{
"sku_id": "1234567890001",
"sale_price": 200,
"sale_stock": 10
},
{
"sku_id": "1234567890002",
"sale_price": 300,
"sale_stock": 10
}
]
},
{
"task_id": "12345688",
"product_id": "12345678002",
"status": 0,
"create_time": 1659516539,
"start_time": 1659516420,
"end_time": 1662022079,
"limited_discount_skus": [
{
"sku_id": "12345678900013",
"sale_price": 20,
"sale_stock": 6
}
]
}
],
"next_key": "THE_NEXT_KEY_NEW",
"total_num": 2
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 10020050 | 无权限调用该api,请开发者获取权限后再试 |
| 10020051 | 参数有误,请检查请求参数是否正确 |
# 8. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。