# 查询开通的电子面单网点/账号信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:ewaybill_getacct
可通过该接口查询商家已经开通的网点账号信息,面单账号信息,包括面单账号的状态,库存等等
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/logistics/ewaybill/biz/account/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:130、159、192
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商) |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| delivery_id | string | 否 | 快递公司编码,详情请参考下文 |
| need_balance | boolean | 是 | 是否需要查询库存 |
| status | number | 否 | 状态过滤,枚举值详情请参考下文 |
| offset | number | 否 | 分页起始位置,默认0 |
| limit | number | 是 | 单次请求数量,当need_balance=true请注意设置合理的limit推荐值小于20,否则limit过大会导致接口超时无返回 |
| acct_id | string | 否 | 物流账号编码:每绑定一个物流商网点/月结账号分配一个acct_id |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| total_num | number | 总条数 |
| account_list | objarray | 账号列表 |
# Res.account_list(Array) Object Payload
账号列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| delivery_id | string | 快递公司id |
| acct_type | number | 面单账号类型 0:普通账号 1:共享账号 |
| company_type | number | 快递公司类型 1:加盟型 2:直营型 |
| shop_id | string | 面单主体ID:每个商家分配的唯一shop_id |
| acct_id | string | 物流账号编码:每绑定一个物流商网点/月结账号分配一个acct_id |
| status | number | 面单账号状态 |
| available | number | 面单余额 |
| allocated | number | 累积已取单 |
| recycled | number | 累积已回收 |
| cancel | number | 累计已取消 |
| monthly_card | string | 月结账号,company_type 为直营型时有效 |
| site_info | object | 网点信息 |
| share | object | 共享账号发起方信息,acct_type 为共享账号时有效 |
| sender_address | object | 绑定的发货地址信息 |
| balance_retcode | number | 查询库存的返回码,错误码取值参考接口错误码列表 |
| balance_retmsg | string | 查询库存的返回信息 |
| delivery_msg | string | 查询库存失败,快递公司返回的详情 |
| available | number | 可用库存,月结类型账号,忽略该字段 |
| allocated | number | 充值的库存数量 |
| recycled | number | 回收的面单库存量 |
| cancel | number | 取消的面单库存量 |
# Res.account_list(Array).site_info Object Payload
网点信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| delivery_id | string | 快递公司编码 |
| site_status | number | 网点运营状态 1:正常 其他值则不正常 |
| site_code | string | 网点编码 |
| site_name | string | 网点名字 |
| address | object | 地址信息 |
| contact | object | 联系信息 |
| site_fullname | string | 地址全名 |
# Res.account_list(Array).site_info.address Object Payload
地址信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| city_code | string | 城市编码 |
| city_name | string | 城市名 |
| country_code | string | 国家编码 |
| detail_address | string | 详细地址 |
| district_code | string | 区县编码 |
| district_name | string | 区县名 |
| province_code | string | 省编码 |
| province_name | string | 省份名 |
| street_code | string | 街道编码 |
| street_name | string | 街道名 |
# Res.account_list(Array).site_info.contact Object Payload
联系信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| mobile | string | 移动电话 |
| name | string | 名称 |
| phone | string | 电话 |
# Res.account_list(Array).share Object Payload
共享账号发起方信息,acct_type 为共享账号时有效
| 参数名 | 类型 | 说明 |
|---|---|---|
| delivery_id | string | 快递公司id |
| site_code | string | 网点编码 |
| site_name | string | 网点名字 |
| acct_id | string | 物流账号编码:每绑定一个物流商网点/月结账号分配一个acct_id |
| nickname | string | 发起共享方店铺名 |
| share_id | string | 共享id |
| shop_id | string | 面单主体ID:每个商家分配的唯一shop_id |
| monthly_card | string | 直营型 月结账号 |
| update_time | number | 更新时间 |
# Res.account_list(Array).sender_address Object Payload
绑定的发货地址信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| province | string | 省 |
| city | string | 市 |
| county | string | 区县 |
| street | string | 街道 |
| address | string | 详细地址 |
# 4. 注意事项
delivery_id快递公司编码
自营性快递公司陆续会接入,快递公司详细信息如下:
| 快递公司名称 | 类型 | delivery_id |
|---|---|---|
| 中通 | 加盟 | ZTO |
| 圆通 | 加盟 | YTO |
| 韵达 | 加盟 | YUNDA |
| 极兔 | 加盟 | JTSD |
| 申通 | 加盟 | STO |
| 顺丰 | 自营 | SF |
| 京东 | 自营 | JD |
| 中国邮政 | 自营 | EMS |
| 菜鸟速递(丹鸟) | 自营 | CNSD |
| 德邦快递 | 自营 | DBKD |
| 顺心捷达 | 加盟 | SXJD |
| 中通快运 | 加盟 | ZTOKY |
| 韵达快运 | 加盟 | YDKY |
| 安能物流 | 加盟 | ANEKY |
| 百世快运 | 加盟 | BTWL |
| 跨越速运 | 直营 | KYSY |
| 壹米滴答 | 加盟 | YMDD |
| 锐界同城速递 | 直营 | RJTCSD |
| 宅急送 | 直营 | ZJS |
| 信丰物流 | 加盟 | XFEX |
| 京广速递 | 加盟 | JGSD |
status状态过滤
| 枚举值 | 描述 |
|---|---|
| 1 | 绑定审核中 |
| 2 | 取消绑定审核中 |
| 3 | 已绑定 |
| 4 | 已解除绑定 |
| 5 | 绑定未通过 |
| 6 | 取消绑定未通过 |
# 5. 代码示例
请求示例
{
"need_balance":true,
"limit":10
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"total_num": 1,
"account_list": [
{
"delivery_id": "JTSD",
"shop_id": "5xxxxxxxxx8",
"acct_id": "6xxxxxxxxx6",
"status": 3,
"available": 0,
"allocated": 0,
"recycled": 0,
"cancel": 0,
"site_info": {
"delivery_id": "JTSD",
"site_status": 1,
"site_code": "2100002",
"site_name": "测试网点02",
"address": {
"city_code": "310100000",
"city_name": "上海市",
"detail_address": "上海上海市青浦区华新镇华隆路1777号",
"district_code": "310118000",
"district_name": "青浦区",
"province_code": "310000000",
"province_name": "上海",
"street_code": "",
"street_name": ""
},
"contact": {
"mobile": "15xxxxxxxxx",
"name": "测试团队",
"phone": "15xxxxxxxxx"
},
"site_fullname": "测试网点02"
}
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10025030 | 请求快递公司接口超时,可稍后重试 | |
| 10025031 | 快递公司接口异常,可稍后重试 | |
| 10025032 | 快递公司接口异常,可能存在故障,可稍后重试 | |
| 10025033 | 快递公司接口繁忙,可稍后重试 | |
| 10025035 | 快递公司的接口不可用,可稍后重试 | |
| 10025102 | 快递公司不支持 | |
| 10025120 | 电子面单帐号列表为空,请检查请求参数 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。