# 获取限时抢购任务列表

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、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 调用相同,调用方式可查看 云调用 说明文档。

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用)

# 请求体 Request Payload

参数名类型必填说明枚举
statusnumber指定获取某个status状态下的限时抢购任务列表,如果不填,则获取所有状态下的限时抢购任务列表枚举值
page_sizenumber每页数量(默认10,不超过50)-
next_keystring由上次请求返回,记录翻页的上下文,传入时会从上次返回的结果往后翻一页,不传默认获取第一页数据-

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
limited_discount_tasksobjarray限时抢购信息
next_keystring本次翻页的上下文,用于请求下一页
total_numnumber商品总数

# Res.limited_discount_tasks(Array) Object Payload

限时抢购信息

参数名类型说明
task_idstring限时抢购任务ID
product_idstring抢购商品ID
statusnumber限时抢购任务状态
create_timenumber限时抢购任务创建时间(秒级时间戳)
start_timenumber限时抢购任务开始时间(秒级时间戳)
end_timenumber限时抢购任务结束时间(秒级时间戳)
limited_discount_skusobjarraylimited_discount_skus

# Res.limited_discount_tasks(Array).limited_discount_skusObject Payload

limited_discount_skus

参数名类型说明
sku_idstring限时抢购任务下不同的sku_id
sale_pricenumber该sku_id的抢购价格
sale_stocknumber该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. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。