微信小程序开发文档 微信小程序 小程序使用·getAllAccount

2024-02-25 开发教程 微信小程序开发文档 匿名 0

logistics.getAllAccount

本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载
wx-server-sdk >= 0.4.0

获取所有绑定的物流账号

调用方式:

  • HTTPS 调用
  • 云调用

HTTPS 调用

请求地址

GET https://api.weixin.qq.com/cgi-bin/express/business/account/getall?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证

返回值

Object

属性类型说明
errcodenumber错误码
errmsgnumber错误信息
countnumber账号数量
listArray.<Object>账号列表

errcode 的合法值

说明最低版本
0成功
-1系统失败

list 的结构

属性类型说明
biz_idstring快递公司客户编码
delivery_idstring快递公司ID
create_timenumber账号绑定时间
update_timenumber账号更新时间
status_codenumber绑定状态
aliasstring账号别名
remark_wrong_msgstring账号绑定失败的错误信息(EMS审核结果)
remark_contentstring账号绑定时的备注内容(提交EMS审核需要)
quota_numnumber电子面单余额
quota_update_timenumber电子面单余额更新时间
service_typeArray.<Object>该绑定帐号支持的服务类型

list.status_code 的合法值

说明最低版本
0绑定成功
1审核中
2绑定失败
3已解绑

list.service_type 的结构

属性类型说明
service_typenumber服务类型ID
service_namestring服务类型名称

返回数据示例

{
"count": 1,
"list": [
{
"biz_id": "123456789",
"delivery_id": "YUNDA",
"create_time": 1555482786,
"update_time": 1556594799,
"status_code": 0,
"alias": "",
"remark_wrong_msg": "",
"remark_content": "",
"quota_num": 55,
"quota_update_time": 1556594799
}
]
}

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.logistics.getAllAccount

需在 config.json 中配置 logistics.getAllAccount API 的权限,详情

返回值

Object

属性类型说明
errCodenumber错误码
errMsgnumber错误信息
countnumber账号数量
listArray.<Object>账号列表

errCode 的合法值

说明最低版本
0成功

list 的结构

属性类型说明
bizIdstring快递公司客户编码
deliveryIdstring快递公司ID
createTimenumber账号绑定时间
updateTimenumber账号更新时间
statusCodenumber绑定状态
aliasstring账号别名
remarkWrongMsgstring账号绑定失败的错误信息(EMS审核结果)
remarkContentstring账号绑定时的备注内容(提交EMS审核需要)
quotaNumnumber电子面单余额
quotaUpdateTimenumber电子面单余额更新时间
serviceTypeArray.<Object>该绑定帐号支持的服务类型

list.statusCode 的合法值

说明最低版本
0绑定成功
1审核中
2绑定失败
3已解绑

list.serviceType 的结构

属性类型说明
serviceTypenumber服务类型ID
serviceNamestring服务类型名称

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgnumber错误信息

errCode 的合法值

说明最低版本
-1系统失败

请求示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.logistics.getAllAccount({})
return result
} catch (err) {
return err
}
}

返回数据示例

{
"count": 1,
"list": [
{
"alias": "",
"bizId": "123456789",
"deliveryId": "YUNDA",
"createTime": 1555482786,
"updateTime": 1556594799,
"statusCode": 0,
"remarkWrongMsg": "",
"remarkContent": "",
"quotaNum": 55,
"quotaUpdateTime": 1556594799
}
],
"errMsg": "openapi.logistics.getAllAccount:ok"
}