全部
电子面单
物流轨迹
物流发货
在线测试
菜鸟电子面单打印
接口地址: http://api.vv-tool.com/tool/accounts/cn-print-electronic-sheet
接口介绍: 菜鸟电子面单打印
请求方式: POST
返回格式: JSON
接口收费: 联系客服
频率限制: 10 次/秒
请求头参数
参数 | 类型 | 必选 | 值 | 示例 |
---|---|---|---|---|
Authorization | string | 是 | 授权 access_token | Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx |
请使用新的生成 token 接口 点击查看详情
请求参数
参数 | 类型 | 必选 | 描述 |
---|---|---|---|
data | object | 是 | 数据 |
--cpCode | string | 是 | 物流公司 Code(详见https://support-cnkuaidi.taobao.com/doc.htm#?docId=105085&docType=1) |
--sender | UserInfoDto | 是 | 发货人信息 |
----address | AddressDto | 是 | 发货地址 |
------city | string | 否 | 城市 |
------detail | string | 是 | 详细地址 |
------district | string | 否 | 区县 |
------province | string | 是 | 省 |
------town | string | 否 | 街道 |
----mobile | string | 否 | 手机号码(手机号和固定电话不能同时为空) |
----name | string | 是 | 姓名 |
----phone | string | 否 | 固定电话(手机号和固定电话不能同时为空) |
--tradeOrderInfoDtos | List |
是 | 请求面单列表(上限 10 个) |
----tradeOrderInfoDto | TradeOrderInfoDto | 是 | 请求面单信息 |
------logisticsServices | string | 否 | 物流服务值(详见https://support-cnkuaidi.taobao.com/doc.htm#?docId=106156&docType=1,如无特殊服务请置空) |
------objectId | string | 是 | 请求 ID(请保证一次批量请求中值不重复,调用方可按该值从返回数据中获取相应结果;只限传入数字、字母和下划线,建议用数字序号下标代替) |
------orderInfo | OrderInfoDto | 是 | 订单信息 |
--------orderChannelsType | string | 是 | 订单渠道平台,请按实际订单所属平台传入(详见https://support-cnkuaidi.taobao.com/doc.htm#?docId=105085&docType=1) |
--------tradeOrderList | List<java.lang.String> | 是 | 订单号列表(上限 100 个) |
----------tradeOrder | string | 是 | 订单号(为避免出现冲突,请按电商平台真实订单号传入,请避免使用同个订单号重复取号;请勿传入 |
------packageInfo | PackageInfoDto | 是 | 包裹信息 |
--------id | string | 是 | 包裹 id,用于拆合单场景(只能传入数字、字母和下划线;批量请求时值不得重复,大小写敏感,即 123A,123a 不可当做不同 ID,否则存在一定可能取号失败) |
--------items | List |
是 | 商品信息,数量限制为 100 |
----------item | Item | 是 | 商品信息 |
------------count | int | 是 | 数量 |
------------name | string | 是 | 名称 |
--------volume | long | 否 | 体积, 单位 ml |
--------weight | long | 否 | 重量,单位 g |
--------totalPackagesCount | long | 否 | 子母件模式中的总包裹数/总件数,用于打印当前包裹处于总件数的位置比如 5-2,可以表示总包裹数为 5,当前为第 2 个包裹,只有快运公司需要传入,其他的可以不用传入 |
--------packagingDescription | string | 否 | 大件快运中的包装方式描述 |
--------goodsDescription | string | 否 | 大件快运中的货品描述,比如服装,家具 |
------recipient | UserInfoDto | 是 | 收件人信息 |
--------address | AddressDto | 是 | 收件人地址 |
----------city | string | 否 | 城市 |
----------detail | string | 是 | 详细地址 |
----------district | string | 否 | 区县 |
----------province | string | 是 | 省 |
----------town | string | 否 | 街道 |
--------mobile | string | 否 | 手机号码(手机号和固定电话不能同时为空) |
--------name | string | 是 | 姓名 |
--------phone | string | 否 | 固定电话(手机号和固定电话不能同时为空) |
------templateUrl | string | 是 | 云打印标准模板 URL(组装云打印结果使用,值格式http://cloudprint.cainiao.com/template/standard/${模板 ID}) |
------userId | long | 是 | 使用者 ID(使用电子面单账号的实际商家 ID,如存在一个电子面单账号多个店铺使用时,请传入店铺的商家 ID) |
--storeCode | string | 否 | 特殊业务使用,如需使用请联系对接人员。 |
--resourceCode | string | 否 | 特殊业务使用,如需使用请联系对接人员。 |
--dmsSorting | boolean | 否 | 特殊业务使用,如需使用请联系对接人员。 |
--needEncrypt | boolean | 否 | 云打印数据是否加密(true-加密;false-不加密) |
请求示例
{
"data": {
"cpCode":"YTO",
"tradeOrderInfoDtos":[
{
"logisticsServices":"{\"SVC-COD\": {\"value\": 100.5}}",
"orderInfo":{
"orderChannelsType":"TB",
"tradeOrderList":[
"1234567890"
]
},
"recipient":{
"address":{
"province":"北京",
"town":"望京街道",
"city":"北京市",
"district":"朝阳区",
"detail":"花家地社区卫生服务站"
},
"phone":"057123222",
"mobile":"1326443654",
"name":"李四"
},
"packageInfo":{
"volume":"1",
"packagingDescription":"5纸3木2拖",
"weight":"1",
"id":"1",
"items":[
{
"count":"1",
"name":"衣服"
}
],
"goodsDescription":"服装",
"totalPackagesCount":"10"
},
"userId":"12",
"objectId":"1",
"templateUrl":"http://cloudprint.cainiao.com/template/standard/101/123"
}
],
"needEncrypt":"false",
"resourceCode":"无",
"sender":{
"address":{
"province":"北京",
"town":"望京街道",
"city":"北京市",
"district":"朝阳区",
"detail":"花家地社区卫生服务站"
},
"phone":"057123222",
"mobile":"1326443654",
"name":"张三"
},
"dmsSorting":"false",
"storeCode":"无"
}
}
请求代码示例
cURL请求代码示例
PHP请求代码示例
JAVA请求代码示例
响应参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | int | 返回状态码 | |
msg | string | 返回码描述 | |
msec | int | 接口执行时间 | |
time | int | 接口返回时间 | |
data | object | 数据信息 | |
--waybillCloudPrintResponseList | list |
电子面单打印信息列表 | |
----waybillCloudPrintResponse | waybillcloudprintresponse | 电子面单打印信息 | |
------objectId | string | 请求 id(与参数传入时相同) | |
------waybillCode | string | 面单号 | |
------printData | string | 云打印内容 | |
------parentWaybillCode | string | 子母件中的母单号,当为子母件模式时,需要此单号为实际挂载物流详情的单号,需要使用此单号进行发货,查询物流详情,非子母件,此字段为空 | |
--withholding_money | int | 该接口扣费金额(点券) |
返回数据
{
"code": 0,
"mag": "",
"msec": "",
"time": 1656564848,
"data": {"waybillCloudPrintResponseList":[
{
"parentWaybillCode":"9890000160004",
"waybillCode":"9890000160004",
"printData":{
"data":"",
"templateURL":"http://cloudprint.cainiao.com/template/standard/101/123"
},
"objectId":"1"
}
]}
}
响应代码
代码 | 代码描述 | 解决方案 |
---|---|---|
0 | 成功 | |
100 | 请求参数错误 | 检查您的请求参数是否正确 |
101 | 请求超时,请重试 | 检查您的网络情况或者联系客服解决 |
103 | 旺旺账号不存在 | 检查您输入的旺旺号是否正确 |
200 | 系统错误,请联系客服 | 检查您的接口地址填写是否正确,其他问题联系客服解决 |
203 | 暂不支持当前接口 | |
204 | 请求异常:无该接口权限,请前往官网开通正式接口。 | 前往官网开通该接口权限 |
204 | 请求异常:API 调用次数不足,请前往网站兑换次数。 | 前往官网充值该接口调用次数 |
302 | 未授权店铺 | 根据返回链接进行扫码授权 |