# 门店运费流水查询
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:intracity_queryflow
查询门店运力资金流水
如有开发问题或建议,可前往微信开放社区-微信物流服务 发帖提问讨论,官方工作人员会及时回复。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/express/intracity/queryflow?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:51
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| wx_store_id | string | 是 | 微信门店编号 | - |
| flow_type | number | 是 | 流水类型 1:充值流水, 2:消费流水,3:退款流水 | - |
| service_trans_id | string | 否 | 运力ID | 枚举值 |
| begin_time | number | 否 | 开始时间戳,不传默认返回最近90天的数据 | - |
| end_time | number | 否 | 结束时间戳,不传默认返回最近90天的数据 | - |
| pay_mode | string | 是 | 扣费主体。门店:PAY_MODE STORE;小程序:PAY_MODE APP;服务商:PAY_MODE_COMPONENT | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| flow_list | objarray | 流水数组。以下信息在请求成功时返回 |
| total_pay_amt | number | 总支付金额 |
| total_refund_amt | number | 总退款金额 |
| total_deduct_amt | number | 总违约金,消费流水返回 |
# Res.flow_list(Array) Object Payload
流水数组。以下信息在请求成功时返回
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| flow_type | number | 流水类型。1:充值流水,2:消费流水,3:退款流水 | - |
| appid | string | appid | - |
| wx_store_id | string | 微信门店ID | - |
| pay_order_id | string | 充值订单号(订单ID) | - |
| service_trans_id | string | 运力ID | - |
| pay_amount | number | 支付金额 | - |
| pay_time | number | 支付时间,时间戳类型 | - |
| pay_status | string | 支付状态,FAIL:支付失败 SUCCESS:支付成功 | - |
| create_time | number | 订单创建时间,时间戳类型 | - |
| consume_deadline | number | 有效截止日期,时间戳类型 | - |
| refund_time | number | 退款时间,时间戳类型。当flow_type=3退款流水时返回 | - |
| refund_amount | number | 退款金额,时间戳类型,单位:分。运单被取消后产生的退款,当flow_type=3/2,退款流水/消费流水时返回 | - |
| openid | string | 用户openid。下单用户的openid,当flow_type=2消费流水时返回 | - |
| delivery_status | number | 运单状态,当flow_type=2消费流水时返回 | 枚举值 |
| refund_status | string | 退款状态,PROCESSING:退款处理中,SUCCESS:退款成功。当flow_type=2消费流水时返回 | - |
| deduct_amount | number | 扣除违约金。运单被取消后产生的违约金,单位:分。当flow_type=2消费流水时返回 | - |
| bill_id | string | 运单ID,运力公司的订单ID。当flow_type=2消费流水时返回 | - |
| delivery_finished_time | number | 运单完成配送的时间,时间戳类型。当flow_type=2消费流水时返回 | - |
# 4. 枚举信息
# Body.service_trans_id Enum
运力ID
| 枚举值 | 描述 |
|---|---|
| DADA | 达达 |
| SFTC | 顺丰同城 |
# Res.flow_list(Array).delivery_status Enum
运单状态,当flow_type=2消费流水时返回
| 枚举值 | 描述 |
|---|---|
| 10000 | 订单创建成功 |
| 20000 | 商家取消订单 |
| 20001 | 配送方取消订单 |
| 30000 | 配送员接单 |
| 40000 | 配送员到店 |
| 50000 | 配送中 |
| 60000 | 配送员撤单 |
| 70000 | 配送完成 |
| 90000 | 配送异常 |
# 5. 注意事项
# 其他说明
# 物品类型列表
| 物品类型 | 类型名称 |
|---|---|
| 1 | 快餐 |
| 2 | 药品 |
| 3 | 百货 |
| 6 | 生鲜 |
| 8 | 酒品 |
| 12 | 文件 |
| 13 | 蛋糕 |
| 14 | 鲜花 |
| 15 | 数码 |
| 16 | 服装 |
| 17 | 汽配 |
| 18 | 珠宝 |
| 32 | 饮料 |
| 36 | 证照 |
| 55 | 宠物用品 |
| 56 | 母婴用品 |
| 57 | 美妆用品 |
| 58 | 家居建材 |
| 99 | 其他 |
# 运力列表
| 运力名称 | 运力ID |
|---|---|
| 达达 | DADA |
| 顺丰同城 | SFTC |
# 6. 代码示例
请求示例
{
"wx_store_id":"4000000000000042002",
"flow_type":1,
"service_trans_id":"SFTC"
}
返回示例
{
"total": 1,
"flow_list": [{
"flow_type": 1,
"appid": "wx539e0b4872f196d1",
"wx_store_id": "4000000000000042002",
"pay_order_id": 2920020938702667776,
"service_trans_id": "SFTC",
"pay_amount": 1,
"refund_amount": 1,
"create_time": 1683639082,
"pay_time": 1683639151,
"refund_time": 1683653491,
"consume_deadline": 1686231082,
"pay_status":"SUCCESS"
}],
"errcode": 0,
"errmsg": "ok",
"total_pay_amt":1,
"total_refund_amt":1
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 0 | 请求成功 |
| 48001 | api unauthorized。原因是小程序没有获得同城配送接口权限,在小程序管理后台开通【同城配送】后即可 |
| 61007 | api is unauthorized to component。此小程序没有授权当前服务商调用接口权限,服务商需获得小程序的51接口权限集 |
| 934000 | 其他逻辑错误 |
| 934001 | 请求参数有误,详细看错误提示 |
| 934002 | 订单已存在,且订单在处理中,请勿重复添加 |
| 934003 | 运力ID错误 |
| 934005 | 运力预创建订单错误 |
| 934006 | 有在途订单,暂不能退款,请等待配送完成 |
| 934007 | 不是在途订单 |
| 934008 | 门店ID和APPID不匹配 |
| 934009 | 不支持该门店所在城市 |
| 934010 | 重复创建门店,请更换out_store_id |
| 934011 | 请求签名错误 |
| 934011 | signature is needed, please refer document for help https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html。 原因是接口没有带签名验证信息,可以参照微信服务端api签名指南的指引开发,同时社区内也有同行分享的php和java的开发实践经验。 |
| 934012 | appid和access_token不匹配 |
| 934013 | 门店余额不足无法下单 |
| 934014 | 运力公司返回了非法金额 |
| 934015 | 余额扣减失败 |
| 934016 | 订单不存在 |
| 934017 | 订单处在不能被取消的状态 |
| 934018 | 订单已取消,请勿重复操作 |
| 934019 | 超出运力支持的配送范围 |
| 934019 | 沙箱环境下单接口返回934019 用户超出配送范围 解决方法:使用顺丰的沙箱环境环境需要固定的收件人信息(达达没有要求) 收件人信息如下:收件人姓名:顺丰同城 收件人手机:13881979410 收件地址:北京市海淀区学清嘉创大厦A座15层 |
| 934020 | 商品超重 |
| 934021 | 门店不存在 |
| 934022 | 账号类型不可以为个人账号 |
| 934023 | 小程序类型必须为普通小程序 |
| 934999 | 内部系统错误 |
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。