# 获取订单列表

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getorderlist

可通过该接口获取微信小店的订单列表

相关事件通知：
- [订单下单事件推送](/doc/store/shop/notify/order_callback/channels_ec_order_new)
- [订单取消事件推送](/doc/store/shop/notify/order_callback/channels_ec_order_cancel)
- [订单支付成功事件推送](/doc/store/shop/notify/order_callback/channels_ec_order_pay)
- [订单待发货事件推送](/doc/store/shop/notify/order_callback/channels_ec_order_wait_shipping)
- [订单发货事件推送](/doc/store/shop/notify/order_callback/channels_ec_order_deliver)
- [订单确认收货事件推送](/doc/store/shop/notify/order_callback/channels_ec_order_confirm)
- [订单结算成功事件推送](/doc/store/shop/notify/order_callback/channels_ec_order_settle)
- [订单其他信息更新](/doc/store/shop/notify/order_callback/channels_ec_order_ext_info)

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：channels.ec.order.list.get

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代微信小店商家调用。[第三方服务商调用模式介绍](/doc/store/shop/dev_before/third_party_platforms)

- 该接口所属的权限集 id 为：131

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代微信小店商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)（微信小店商家）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "create_time_range",
    "类型": "object",
    "必填": "是",
    "示例": "",
    "说明": "订单创建时间范围，时间范围至少填一个",
    "枚举": "-"
  },
  {
    "参数名": "update_time_range",
    "类型": "object",
    "必填": "是",
    "示例": "",
    "说明": "订单更新时间范围，时间范围至少填一个",
    "枚举": "-"
  },
  {
    "参数名": "status",
    "类型": "number",
    "必填": "否",
    "示例": "",
    "说明": "订单状态，具体枚举值请参考下文",
    "枚举": "枚举值"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "买家身份标识，可通过 [订单下单通知](/doc/store/shop/notify/order_callback/channels_ec_order_new)、[订单通知：合作帐号小程序](/doc/store/shop/linkstore/miniprogram_connection/miniprogram_callback/Order_notification) 获取",
    "枚举": "-"
  },
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "否",
    "示例": "",
    "说明": "每页数量(不超过100)",
    "枚举": "-"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "必填": "是",
    "示例": "10",
    "说明": "分页参数，上一页请求返回",
    "枚举": "-"
  }
]
```

### Body.create_time_range `Object Payload`

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

```json
[
  {
    "参数名": "start_time",
    "类型": "number",
    "必填": "是",
    "说明": "秒级时间戳（距离end_time不可超过7天）"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "必填": "是",
    "说明": "秒级时间戳（距离start_time不可超过7天）"
  }
]
```

### Body.update_time_range `Object Payload`

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

```json
[
  {
    "参数名": "start_time",
    "类型": "number",
    "必填": "是",
    "说明": "秒级时间戳（距离end_time不可超过7天）"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "必填": "是",
    "说明": "秒级时间戳（距离start_time不可超过7天）"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "order_id_list",
    "类型": "array",
    "说明": "订单号列表"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "说明": "分页参数，下一页请求返回"
  },
  {
    "参数名": "has_more",
    "类型": "boolean",
    "说明": "bool\t是否还有下一页，true:有下一页；false:已经结束，没有下一页。"
  }
]
```

## 4. 枚举信息

### Body.status `Enum`

订单状态，具体枚举值请参考下文

```json
[
  {
    "枚举值": "10",
    "描述": "待付款"
  },
  {
    "枚举值": "12",
    "描述": "礼物待收下"
  },
  {
    "枚举值": "13",
    "描述": "一起买待成团"
  },
  {
    "枚举值": "20",
    "描述": "待发货（包括部分发货"
  },
  {
    "枚举值": "21",
    "描述": "部分发货"
  },
  {
    "枚举值": "30",
    "描述": "待收货（包括部分发货）"
  },
  {
    "枚举值": "100",
    "描述": "完成"
  },
  {
    "枚举值": "250",
    "描述": "订单取消（包括未付款取消，售后取消等）"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

请求示例

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

返回示例

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

## 7. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

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

## 8. 适用范围

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

![](https://res8.wxqcloud.qq.com.cn/wxdoc/56617deb-b17d-4cf1-bccd-71d2c41ccc76.svg)接口变更日志（1条）
2025 年 12 月 03 日更新  `page_size` 、 `next_key`  字段描述