# 查询礼物订单列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:get_present_list
可通过该接口获取使用当前小程序发放的小店礼物单列表。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/order/presentlist/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| create_time_range | object | 否 | 礼物单创建时间范围,时间范围至少填一个 |
| update_time_range | object | 否 | 礼物单更新时间范围,时间范围至少填一个 |
| shop_appid | string | 是 | 小店appid |
| page_size | number | 是 | 每页数量(不超过100) |
| next_key | string | 否 | 分页参数,上一页请求返回,首次置空即可 |
# Body.create_time_range Object Payload
礼物单创建时间范围,时间范围至少填一个
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| start_time | number | 是 | 开始时间,秒级时间戳(距离end_time不可超过7天) |
| end_time | number | 是 | 结束时间,秒级时间戳(距离start_time不可超过7天) |
# Body.update_time_range Object Payload
礼物单更新时间范围,时间范围至少填一个
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| start_time | number | 是 | 开始时间,秒级时间戳(距离end_time不可超过7天) |
| end_time | number | 是 | 结束时间,秒级时间戳(距离start_time不可超过7天) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| present_order_list | objarray | 礼物单ID |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| next_key | string | 分页参数,下一页请求时传入 |
# Res.present_order_list(Array) Object Payload
礼物单ID
| 参数名 | 类型 | 说明 |
|---|---|---|
| present_order_id | string | - |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"shop_appid": "wx21b9c6e52edfe3a1",
"create_time_range":{
"start_time": 1749007175,
"end_time": 1749008175
},
"page_size": 10,
"next_key": "CPestckGEPeVxckGGAAgACgAMAA4gKbYu/HiyeYzQJ7JuskA"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"present_order_list": {
"present_order_id": "4226341196275651234"
},
"next_key": "CPestckGEPeVxckGGAAgACgAMAA4gKbYu/HiyeYzQJ7JuskA"
}
# 6. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
| 小程序 | 小游戏 |
|---|---|
| ✔ | ✔ |
- ✔:该账号可调用此接口。
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口。
2025 年 12 月 08 日
新增 查询礼物单列表