# 获取佣金单列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getorderlist
可通过该接口获取佣金单列表
# 1. 调用方式
# HTTPS 调用
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 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
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
佣金单创建时间范围,填了佣金单更新时间范围则不填该时间,创建时间和更新时间必填一个
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
start_time | number | 否 | 1676375581 | 开始时间,秒级时间戳 |
end_time | number | 否 | 1676375754 | 结束时间,秒级时间戳 |
# Body.update_time_range Object Payload
佣金单更新时间范围,填了佣金单创建时间范围则不填该时间,创建时间和更新时间必填一个
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
start_time | number | 否 | 1676375581 | 开始时间,秒级时间戳 |
end_time | number | 否 | 1676375754 | 结束时间,秒级时间戳 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
errcode | number | 0 | 错误码 |
errmsg | string | ok | 错误信息 |
list | objarray | list | |
next_key | string | 本次翻页的上下文,用于顺序翻页请求 | |
has_more | boolean | 是否还有剩余商品 |
# Res.list(Array) Object Payload
list
参数名 | 类型 | 说明 |
---|---|---|
order_id | string | 商品id |
sku_id | number | skuid |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"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": ""
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"list": {
"order_id": "0",
"sku_id": 0
},
"next_key": "",
"has_more": false
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10024000 | 参数错误,请开发人员检查传递参数是否正确 | |
10024001 | 不合法的finder_id | |
10024003 | 不合法的appid |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。