# 查询礼物订单详情
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:get_present
通过该接口查询使用当前小程序发放的小店礼物单详情。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/order/present/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| present_order_id | string | 是 | 4226341196275651234 | 礼物单ID |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| present | object | 礼物单结构 |
# Res.present Object Payload
礼物单结构
| 参数名 | 类型 | 说明 |
|---|---|---|
| present_order_id | string | 礼物单ID |
| create_time | number | 创建时间,秒级时间戳 |
| present_detail | object | 礼物单详情 |
| sub_order_list | objarray | 礼物单中的子单列表 |
| is_b2c_free_present | boolean | 礼物单是否付款 0:已付款 1:无需付款。商家选择自己店铺的商品在公众号/服务号/企业微信/小程序/小游戏/直播间等场景送礼物时,无需付款 |
| activity_id | string | 礼物单关联的活动ID |
# Res.present.present_detail Object Payload
礼物单详情
| 参数名 | 类型 | 说明 |
|---|---|---|
| price_info | object | 价格信息 |
| pay_info | object | 支付信息 |
| wishmessage | string | 祝福语 |
# Res.present.present_detail.price_info Object Payload
价格信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| order_price | number | 礼物单价格 |
# Res.present.present_detail.pay_info Object Payload
支付信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| pay_time | number | 礼物单支付时间 |
# Res.present.sub_order_list(Array) Object Payload
礼物单中的子单列表
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| order_id | string | 子单订单ID | - |
| openid | string | 收礼者openid | - |
| status | number | 子单订单状态 | 枚举值 |
# 4. 枚举信息
# Res.present.sub_order_list(Array).status Enum
子单订单状态
| 枚举值 | 描述 |
|---|---|
| 12 | 礼物待收下 |
| 20 | 待发货 |
| 21 | 部分发货 |
| 30 | 待收货 |
| 100 | 完成 |
| 180 | 礼物单过期 |
| 200 | 全部商品售后之后,订单取消 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"present_order_id": "4232433395290081234"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"present": {
"present_order_id": "4232433395290081234",
"create_time": 1763713709,
"present_detail": {
"price_info": {
"order_price": 100
},
"pay_info": {
"pay_time": 1763715605
},
"wishmessage": "大家一起来抽奖"
},
"sub_order_list": [
{
"order_id": "3732433407897635321",
"openid": "oDiTs6_jRMfM4lualWTODbwt42kB",
"status": 30
},
{
"order_id": "3732433407896586753",
"status": 12
}
],
"is_b2c_free_present": false,
"activity_id": "3002981"
}
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 6080077 | 礼物单号错误 |
# 8. 适用范围
本接口在不同账号类型下的可调用情况:
| 小程序 | 小游戏 |
|---|---|
| ✔ | ✔ |
- ✔:该账号可调用此接口
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;
2025 年 12 月 08 日
新增 查询礼物订单详情