# 门店余额查询

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：intracity_balancequery

查询门店运力余额

如有开发问题或建议，可前往[微信开放社区-微信物流服务](https://developers.weixin.qq.com/community/minihome/mixflow/1792207662500118536) 发帖提问讨论，官方工作人员会及时回复。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/express/intracity/balancequery?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：51

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "wx_store_id",
    "类型": "string",
    "必填": "否",
    "说明": "微信门店编号。pay_mode = PAY_MODE_STORE时必传，不传pay_mode时必传wx_store_id"
  },
  {
    "参数名": "service_trans_id",
    "类型": "string",
    "必填": "否",
    "说明": "运力ID。查询门店在指定运力ID充值的余额，不指定则查询全部"
  },
  {
    "参数名": "pay_mode",
    "类型": "string",
    "必填": "否",
    "说明": "充值/扣费主体。门店：PAY_MODE_STORE；小程序:PAY_MODE_APP；服务商：PAY_MODE_COMPONENT，不传pay_mode默认pay_mode=PAY_MODE_STORE"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "示例": "0",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "示例": "ok",
    "说明": "错误信息。"
  },
  {
    "参数名": "wx_store_id",
    "类型": "string",
    "示例": "",
    "说明": "门店ID。以下信息在请求成功时返回"
  },
  {
    "参数名": "appid",
    "类型": "string",
    "示例": "-",
    "说明": "appid"
  },
  {
    "参数名": "all_balance",
    "类型": "number",
    "示例": "-",
    "说明": "总余额"
  },
  {
    "参数名": "balance_detail",
    "类型": "object",
    "示例": "-",
    "说明": "余额详情"
  }
]
```

### Res.balance_detail `Object Payload`

余额详情

```json
[
  {
    "参数名": "balance",
    "类型": "number",
    "说明": "余额"
  },
  {
    "参数名": "service_trans_id",
    "类型": "string",
    "说明": "运力ID"
  },
  {
    "参数名": "service_trans_name",
    "类型": "string",
    "说明": "运力名称"
  },
  {
    "参数名": "order_list",
    "类型": "object",
    "说明": "充值订单详情。当前生效的充值且余额没有被消费完的充值订单详情，订单充值后，没有被消费完会自动退款。"
  }
]
```

### Res.balance_detail.order_list `Object Payload`

充值订单详情。当前生效的充值且余额没有被消费完的充值订单详情，订单充值后，没有被消费完会自动退款。

```json
[
  {
    "参数名": "payorder_id",
    "类型": "string",
    "说明": "充值订单号"
  },
  {
    "参数名": "charge_amt",
    "类型": "number",
    "说明": "充值金额"
  },
  {
    "参数名": "unused_amt",
    "类型": "number",
    "说明": "未使用的余额"
  },
  {
    "参数名": "begin_time",
    "类型": "number",
    "说明": "充值生效时间，时间戳类型"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "说明": "失效时间，时间戳类型，超过该时间，余额没有被消费完会退款"
  }
]
```

## 4. 注意事项

# 其他说明

### 物品类型列表

| 物品类型 | 类型名称 |
| - | - |
| 1 | 快餐 |
| 2 | 药品 |
| 3 | 百货 |
| 6 | 生鲜 |
| 8 | 酒品 |
| 12 | 文件 |
| 13 | 蛋糕 |
| 14 | 鲜花 |
| 15 | 数码 |
| 16 | 服装 |
| 17 | 汽配 |
| 18 | 珠宝 |
| 32 | 饮料 |
| 36 | 证照 |
| 55 | 宠物用品 |
| 56 | 母婴用品 |
| 57 | 美妆用品 |
| 58 | 家居建材 |
| 99 | 其他 |

### 运力列表

| 运力名称 | 运力ID |
| - | - |
| 达达 | DADA |
| 顺丰同城 | SFTC |

## 5. 代码示例

请求示例

```json
{
"wx_store_id":"4000000000000042001",
"service_trans_id":"DADA"
}
```

返回示例

```json
{
	"appid": "wx539e0b4872f196d1",
	"wx_store_id": "4000000000000042001",
	"all_balance": 10,
	"balance_detail": [{
		"balance": 10,
		"service_trans_id": "DADA",
		"service_trans_name": "达达快送",
		"order_list": [{
			"payorder_id": "2978080038359269380",
			"unused_amt": 10,
			"charge_amt": 10,
			"begin_time": 1687099701,
			"end_time": 1689691701
		}]
	}],
	"errcode": 0,
	"errmsg": "OK"
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "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 [1000411]([1000411)。 原因是接口没有带签名验证信息，可以参照[微信服务端api签名指南](/miniprogram/dev/server/getting_started/api_signature)的指引开发，同时社区内也有同行分享的[php](https://developers.weixin.qq.com/community/develop/article/doc/00028ca675c708b23f100b8e161013)和[java](https://developers.weixin.qq.com/community/develop/article/doc/000e68b8038ed8796f00f6c2f68c13)的开发实践经验。"
  },
  {
    "错误码": "934012",
    "错误描述": "appid和access_token不匹配"
  },
  {
    "错误码": "934013",
    "错误描述": "门店余额不足无法下单"
  },
  {
    "错误码": "934014",
    "错误描述": "运力公司返回了非法金额"
  },
  {
    "错误码": "934015",
    "错误描述": "余额扣减失败"
  },
  {
    "错误码": "934016",
    "错误描述": "订单不存在"
  },
  {
    "错误码": "934017",
    "错误描述": "订单处在不能被取消的状态"
  },
  {
    "错误码": "934018",
    "错误描述": "订单已取消，请勿重复操作"
  },
  {
    "错误码": "934019",
    "错误描述": "超出运力支持的配送范围"
  },
  {
    "错误码": "934019",
    "错误描述": "沙箱环境下单接口返回934019 用户超出配送范围 解决方法：使用顺丰的沙箱环境环境需要固定的收件人信息（达达没有要求）  收件人信息如下：收件人姓名：顺丰同城 收件人手机：13881979410  收件地址：北京市海淀区学清嘉创大厦A座15层"
  },
  {
    "错误码": "934020",
    "错误描述": "商品超重"
  },
  {
    "错误码": "934021",
    "错误描述": "门店不存在"
  },
  {
    "错误码": "934022",
    "错误描述": "账号类型不可以为个人账号"
  },
  {
    "错误码": "934023",
    "错误描述": "小程序类型必须为普通小程序"
  },
  {
    "错误码": "934999",
    "错误描述": "内部系统错误"
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。