# 获取佣金单列表

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

接口英文名：getorderlist

可通过该接口获取佣金单列表

## 1. 调用方式

### HTTPS 调用

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

### 云调用

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

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

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

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

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/leagueheadsupplier/api/basic/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "appid",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "佣金单所属小店appid"
  },
  {
    "参数名": "finder_id",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "视频号finder_id"
  },
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "是",
    "示例": "1",
    "说明": "单页佣金单数（不超过30）"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "由上次请求返回，顺序翻页时需要传入, 会从上次返回的结果往后翻一页"
  },
  {
    "参数名": "create_time_range",
    "类型": "object",
    "必填": "否",
    "示例": "",
    "说明": "佣金单创建时间范围，填了佣金单更新时间范围则不填该时间，创建时间和更新时间必填一个"
  },
  {
    "参数名": "update_time_range",
    "类型": "object",
    "必填": "否",
    "示例": "",
    "说明": "佣金单更新时间范围，填了佣金单创建时间范围则不填该时间，创建时间和更新时间必填一个"
  },
  {
    "参数名": "order_id",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "订单ID，填此参数后其他过滤参数无"
  },
  {
    "参数名": "openfinderid",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "视频号openfinderid"
  },
  {
    "参数名": "sharer_appid",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "用于查询推客，或者达人平台产生的订单数据"
  }
]
```

### Body.create_time_range `Object Payload`

佣金单创建时间范围，填了佣金单更新时间范围则不填该时间，创建时间和更新时间必填一个

```json
[
  {
    "参数名": "start_time",
    "类型": "number",
    "必填": "否",
    "示例": "1676375581",
    "说明": "开始时间，秒级时间戳"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "必填": "否",
    "示例": "1676375754",
    "说明": "结束时间，秒级时间戳"
  }
]
```

### Body.update_time_range `Object Payload`

佣金单更新时间范围，填了佣金单创建时间范围则不填该时间，创建时间和更新时间必填一个

```json
[
  {
    "参数名": "start_time",
    "类型": "number",
    "必填": "否",
    "示例": "1676375581",
    "说明": "开始时间，秒级时间戳"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "必填": "否",
    "示例": "1676375754",
    "说明": "结束时间，秒级时间戳"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "示例": "0",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "示例": "ok",
    "说明": "错误信息"
  },
  {
    "参数名": "list",
    "类型": "objarray",
    "示例": "",
    "说明": "list"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "示例": "",
    "说明": "本次翻页的上下文，用于顺序翻页请求"
  },
  {
    "参数名": "has_more",
    "类型": "boolean",
    "示例": "",
    "说明": "是否还有剩余商品"
  }
]
```

">

### Res.list(Array) `Object Payload`

list

```json
[
  {
    "参数名": "order_id",
    "类型": "string",
    "说明": "订单id"
  },
  {
    "参数名": "sku_id",
    "类型": "number",
    "说明": "skuid"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "appid": "",
    "finder_id": "",
    "page_size": 1,
    "next_key": "",
    "create_time_range": {
        "start_time": 1676375581,
        "end_time": 1676375754
    },
    "update_time_range": {
        "start_time": 1676375581,
        "end_time": 1676375754
    },
    "order_id": "0",
    "openfinderid": "",
    "sharer_appid": ""
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "list": {
        "order_id": "0",
        "sku_id": 0
    },
    "next_key": "",
    "has_more": false
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "10024000",
    "错误描述": "参数错误，请开发人员检查传递参数是否正确"
  },
  {
    "错误码": "10024001",
    "错误描述": "不合法的finder_id"
  },
  {
    "错误码": "10024003",
    "错误描述": "不合法的appid"
  }
]
```

## 7. 适用范围

本接口支持「联盟带货机构」账号类型调用。其他账号类型如无特殊说明，均不可调用。