# 获取用户已支付订单列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:get_paid_order_list
本接口用于获取用户已支付订单列表
对于普通业务,access_token为第三方平台component_access_token 对于设计工具类业务,access_token为服务平台的企业主页的access_token
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/servicemarket/get_paid_order_list?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:3、17
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| service_id | number | 是 | 服务id,64位无符号整数,不填或0代表拉取全部服务 |
| appid | string | 否 | 小程序appid,当buyer_type为1时必填 |
| offset | number | 是 | 列表偏移 |
| limit | number | 是 | 列表长度 |
| openid | string | 否 | 用户在服务平台的openid,当buyer_type为2时必填 |
| buyer_type | number | 是 | 买家类型,1是小程序,2是微信用户,默认为1 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| order_list | objarray | 订单列表 |
# Res.order_list(Array) Object Payload
订单列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| order_id | number | 订单id,64位无符号整数 |
| effective_time | number | 生效时间,unix32位时间戳 |
| expire_time | number | 过期时间,unix32位时间戳 |
| specification_id | string | 规格id |
| service_id | number | 服务id,64位无符号整数 |
| total_price | number | 订单金额,单位分 |
| phone | string | 手机号,仅设计服务类返回 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"appid":"wx2333",
"service_id": 10000000005,
"offset":0,
"limit":20,
"openid":"xxx",
"buyer_type":1
}
返回示例
{
"errcode": 0,
"errmsg":"ok",
"order_list":
[
{
"order_id":123,
"effective_time":1640173379,
"expire_time":1640259780,
"specification_id":"special",
"phone":"18888888888"
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10012 | appid非法 | |
| 10031 | 不存在对应的账单执行第三方分账 | 检查out_trade_no是否为对应商户号下交易成功的订单 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
| 小程序 | 服务号 | 小游戏 |
|---|---|---|
| ✔ | 仅认证 | ✔ |
- ✔:该账号可调用此接口。
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用。
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口。