# 获取订单列表

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getorderlist

可通过该接口获取视频号小店的订单列表

相关事件通知:

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/order/list/get?access_token=ACCESS_TOKEN

# 云调用

  • 调用方法:channels.ec.order.list.get

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:131

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
create_time_rangeobject订单创建时间范围,时间范围至少填一个
update_time_rangeobject订单更新时间范围,时间范围至少填一个
statusnumber订单状态,具体枚举值请参考下文
openidstring买家身份标识
page_sizenumber分页参数,上一页请求返回
next_keystring10每页数量(不超过100)

# Body.create_time_range Object Payload

订单创建时间范围,时间范围至少填一个

参数名类型必填说明
start_timenumber秒级时间戳(距离end_time不可超过7天)
end_timenumber秒级时间戳(距离start_time不可超过7天)

# Body.update_time_range Object Payload

订单更新时间范围,时间范围至少填一个

参数名类型必填说明
start_timenumber秒级时间戳(距离end_time不可超过7天)
end_timenumber秒级时间戳(距离start_time不可超过7天)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
order_id_listarray订单号列表
next_keystring分页参数,下一页请求返回
has_morebooleanbool 是否还有下一页,true:有下一页;false:已经结束,没有下一页。

# 4. 注意事项

订单状态

枚举值 描述
10 待付款
20 待发货(包括部分发货)
21 部分发货
30 待收货(包括部分发货)
100 完成
250 订单取消(包括未付款取消,售后取消等)

# 5. 代码示例

请求示例

{
    "create_time_range": {
        "start_time": 1658505600,
        "end_time": 1658509200
    },
    "page_size": 10,
    "next_key": "THE_NEXT_KEY"
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "order_id_list": [
        "3704612354559743232",
        "3704849110714209536"
    ],
    "next_key": "THE_NEXT_KEY_NEW",
    "has_more": true
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
31042请求内订单过多,请缩短时间范围后重试
40097请求体参数不正确,请检查各个参数是否按规范填写,具体原因查看errmsg
47001请求体格式不正确,请检查请求体中各个参数的类型是否正确
606006next_key参数不正确,本次请求参数与上一页不一致

# 7. 适用范围

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