文明接口文档- v兔电商工具
明文接口
接口地址： http://api.vv-tool.com/tool/erps/waybill-new
必须用户授权 : 需要用户的授权，才能拿到被授权的数据
请求方式： POST
返回格式： JSON
接口收费： 按照次数收费
请求头参数
参数类型必选值示例
Authorizationstring是授权 access_tokenBearer 1798c6aadec33d1bc2f5b707f1049aefexxxx
请求参数
类型必须示例值描述
param_waybill
_cloud_print_apply_new_requestWaybillCloudPrintApplyNewRequesttrue入参信息
cp_codeStringtruePOSTB物流公司 Code，长度小于 20
product_codeStringfalse目前已经不推荐使用此字段，请不要使用目前已经不推荐使用此字段，请不要使用
senderUserInfoDtotrue发货人信息
addressAddressDtotrue发货地址需要通过 search 接口
cityStringfalse北京市城市，长度小于 20
detailStringtrue花家地社区卫生服务站详细地址，长度小于 256
districtStringfalse朝阳区区，长度小于 20
provinceStringtrue北京省，长度小于 20
townStringfalse望京街道街道，长度小于 30
mobileStringfalse1326443654手机号码（手机号和固定电话不能同时为空），长度小于 20
nameStringtrueBar姓名，长度小于 40
phoneStringfalse057123222固定电话（手机号和固定电话不能同时为空），长度小于 20
trade_order_info_dtosTradeOrderInfoDto[]true请求面单信息，数量限制为 10
logistics_servicesStringfalse如不需要特殊服务，该值为空物流服务值（详见https://support-cnkuaidi.taobao.com/doc.htm#?docId=106156&docType=1，如无特殊服务请置空）
object_idStringtrue1请求 ID
order_infoOrderInfoDtotrue订单信息
order_channels_typeStringtrueTB订单渠道平台编码
trade_order_listString[]true1222221订单号，数量限制 100，订单号（只限传入数字、字母、下划线和中划线，为避免出现冲突，请按电商平台真实订单号传入，请避免使用同个订单号重复取号）
out_trade_order_listString[]false123456,456789外部电商平台交易单号集合，非必填，数量限制 100
out_trade_sub_order_listString[]false12,34,56,78外部电商平台交易子单号集合，非必填，数量限制 100
package_infoPackageInfoDtotrue包裹信息
idStringfalse1包裹 id，用于拆合单场景（只能传入数字、字母和下划线；批量请求时值不得重复，大小写敏感，即 123A,123a 不可当做不同 ID，否则存在一定可能取号失败）
itemsItem[]true商品信息，数量限制为 100
countNumbertrue1数量
nameStringtrue衣服名称
volumeNumberfalse1体积， 单位 ml
weightNumberfalse1重量，单位 g
total_packages_countNumberfalse10子母件模式中的总包裹数/总件数，用于打印当前包裹处于总件数的位置比如 5-2，可以表示总包裹数为 5，当前为第 2 个包裹，只有快运公司需要传入，其他的可以不用传入
packaging_descriptionStringfalse5 纸 3 木 2 拖大件快运中的包装方式描述
goods_descriptionStringfalse服装大件快运中的货品描述，比如服装，家具
recipientRecipientInfoDtotrue收件人信息
addressAddressDtotrue地址
cityStringfalse北京市城市
detailStringtrue花家地社区卫生服务站详细地址
districtStringfalse朝阳区区
provinceStringtrue北京省
townStringfalse望京街道街道
mobileStringfalse1326443654手机号码
nameStringtrueBar姓名
phoneStringfalse057123222固定电话
oaidStringfalseabcdefghijk淘宝订单收件人 ID (Open Addressee ID)，长度不超过 128 个字符，淘宝订单加密情况用于解密。
tidStringfalse1527014522198024829电商平台真实交易订单号，针对电商平台订单隐私加密场景使用，非必填，如果填写则必须是电商平台真实的交易订单 ID
caidStringfalseAs268woscee菜鸟解密地址 ID，用于电商平台收件人信息加密的场景使用，非订单加密场景请勿使用。
template_urlStringtruehttp://cloudprint.cainiao.com/template/standard/101云打印标准模板 URL（组装云打印结果使用，值格式http://cloudprint.cainiao.com/template/standard/${模板 ID}）
user_idNumbertrue12使用者 ID（使用电子面单账号的实际商家 ID，如存在一个电子面单账号多个店铺使用时，请传入店铺的商家 ID）
store_codeStringfalse553323仓 code， 仓库 WMS 系统对接落地配业务，其它场景请不要使用
resource_codeStringfalseDISTRIBUTOR_978324配送资源 code， 仓库 WMS 系统对接落地配业务，其它场景请不要使用
dms_sortingBooleanfalsefalse是否使用智分宝预分拣， 仓库 WMS 系统对接落地配业务，其它场景请不要使用
three_pl_timingBooleanfalsefalse订单上是否带 3PLtiming 属性， 该属性需要严格与订单上属性保持一致，如果不确定，请使用默认 false。
need_encryptBooleanfalsefalse设定取号返回的云打印报文是否加密
multi_packages_shipmentBoolean否false快递公司支持一票多件，快运公司子母件请勿使用该参数
brand_codeString否FOP品牌编码
extra_infoString否扩展参数
customer_codeString否adb123345月结卡号
call_door_pick_upBoolean否false是否预约上门
door_pick_up_timeString否2021-08-07 12:34:30预约上门收件时间
door_pick_up_end_timeString否2021-08-07 12:34:30预约上门截止时间
shipping_branch_codeString否10001寄件网点编码
vvtypeintfalse普通版 1，不传默认 1，增强版 2，增强版的需要传参 2
is_cancel intfalse是否取消出单的快递单号；1否，2是（取消单号）
请求示例
{
"shop_id": "227582782",
"param_waybill_cloud_print_apply_new_request": {
"cp_code": "YTO",
"sender": {
"address": {
"detail": "山东省",
"province": "曹县里面的 302"
},
"name": "大哥"
},
"trade_order_info_dtos": [
{
"object_id": "1655",
"order_info": {
"order_channels_type": "TB",
"trade_order_list": [
"5324151342152412421"
]
},
"package_info": {
"items": [
{
"count": "1",
"name": "大风车这样"
}
]
},
"recipient": {
"address": {
"detail": "牛逼 666",
"province": "河南省"
},
"name": "zNXr6j4AMsdafsadassdsadg"
},
"template_url": "http://cloudprint.cainiao.com/template/standard/101",
"user_id": 12
}]
}
}
请求代码示例
cURL请求代码示例
curl --location --request POST "http://api.vv-tool.com/tool/erps/waybill-new" \
--header "Authorization: Bearer 762ac11440e85e21weqrqwtwtrwq" \
--header "Content-Type: application/json" \
--header "Cookie: PHPSESSID=6ded377bfo53vo6rbd6mk5l2ea; _csrf=e1edda6cb603e3cfad034b10aab40761e1ef1bacca7becf624004fbfe07c32cfa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%228vE5OSCWl31W9ilB6idHM4-ykPG3q10I%22%3B%7D" \
--data-raw "{
"shop_id": "227582782",
"param_waybill_cloud_print_apply_new_request": {
"cp_code": "YTO",
"sender": {
"address": {
"detail": "山东省",
"province": "曹县里面的302"
},
"name": "大哥"
},
"trade_order_info_dtos": [
{
"object_id": "1655",
"order_info": {
"order_channels_type": "TB",
"trade_order_list": [
"5324151342152412421"
]
},
"package_info": {
"items": [
{
"count": "1",
"name": "大风车这样"
}
]
},
"recipient": {
"address": {
"detail": "牛逼666",
"province": "河南省"
},
"name": "~zNXr6j4AMsdafsadassdsadg~"
},
"template_url": "http://cloudprint.cainiao.com/template/standard/101",
"user_id": 12
}]
}
}"
PHP请求代码示例
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.vv-tool.com/tool/erps/waybill-new",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS =>"{
"shop_id": "227582782",
"param_waybill_cloud_print_apply_new_request": {
"cp_code": "YTO",
"sender": {
"address": {
"detail": "山东省",
"province": "曹县里面的302"
},
"name": "大哥"
},
"trade_order_info_dtos": [
{
"object_id": "1655",
"order_info": {
"order_channels_type": "TB",
"trade_order_list": [
"5324151342152412421"
]
},
"package_info": {
"items": [
{
"count": "1",
"name": "大风车这样"
}
]
},
"recipient": {
"address": {
"detail": "牛逼666",
"province": "河南省"
},
"name": "~zNXr6j4AMsdafsadassdsadg~"
},
"template_url": "http://cloudprint.cainiao.com/template/standard/101",
"user_id": 12
}]
}
}",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer 762ac11440e85e21weqrqwtwtrwq",
"Content-Type: application/json",
"Cookie: PHPSESSID=6ded377bfo53vo6rbd6mk5l2ea; _csrf=e1edda6cb603e3cfad034b10aab40761e1ef1bacca7becf624004fbfe07c32cfa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%228vE5OSCWl31W9ilB6idHM4-ykPG3q10I%22%3B%7D"
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
JAVA请求代码示例
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"shop_id\": \"227582782\",\r\n \"param_waybill_cloud_print_apply_new_request\": {\r\n \"cp_code\": \"YTO\",\r\n \"sender\": {\r\n \"address\": {\r\n \"detail\": \"山东省\",\r\n \"province\": \"曹县里面的302\"\r\n },\r\n \"name\": \"大哥\"\r\n },\r\n \"trade_order_info_dtos\": [\r\n {\r\n \"object_id\": \"1655\",\r\n \"order_info\": {\r\n \"order_channels_type\": \"TB\",\r\n \"trade_order_list\": [\r\n \"5324151342152412421\"\r\n ]\r\n },\r\n \"package_info\": {\r\n \"items\": [\r\n {\r\n \"count\": \"1\",\r\n \"name\": \"大风车这样\"\r\n }\r\n ]\r\n },\r\n \"recipient\": {\r\n \"address\": {\r\n \"detail\": \"牛逼666\",\r\n \"province\": \"河南省\"\r\n },\r\n \"name\": \"~zNXr6j4AMsdafsadassdsadg~\"\r\n },\r\n \"template_url\": \"http://cloudprint.cainiao.com/template/standard/101\",\r\n \"user_id\": 12\r\n \r\n }]\r\n }\r\n}");
Request request = new Request.Builder()
.url("http://api.vv-tool.com/tool/erps/waybill-new")
.method("POST", body)
.addHeader("Authorization", "Bearer 762ac11440e85e21weqrqwtwtrwq")
.addHeader("Content-Type", "application/json")
.addHeader("Cookie", "PHPSESSID=6ded377bfo53vo6rbd6mk5l2ea; _csrf=e1edda6cb603e3cfad034b10aab40761e1ef1bacca7becf624004fbfe07c32cfa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%228vE5OSCWl31W9ilB6idHM4-ykPG3q10I%22%3B%7D")
.build();
Response response = client.newCall(request).execute();
响应参数
名称类型示例值描述
modulesWaybillCloudPrintResponse []xx系统自动生成
object_idString12请求 id
waybill_codeString9890000160004面单号， 子母件模式下为子面单号
print_dataString云打印内容（encryptedData 表示加密结果，data 表示非加密结果）;模板内容，具体解释见链接
parent_waybill_codeString9890000160004子母件中的母单号，当为子母件模式时，需要此单号为实际挂载物流详情的单号，需要使用此单号进行发货，查询物流详情，非子母件，此字段为空
recipientRecipientInfoDto{}收件人信息
addressAddressDto{}地址
detailString花家地社区卫生服务站详细地址
provinceString北京省
mobileString1326443654手机号码
nameStringBar姓名
返回数据
{
"code": 0,
"msg": "操作成功",
"msec": 1460,
"time": 1617273033,
"data":
{
"withholding_money": 1,
"cainiao_waybill_ii_get_response":{
"modules":{
"waybill_cloud_print_response":[
{
"object_id":"12",
"waybill_code":"9890000160004",
"print_data":"{\\\"data\\\":{\\\"recipient\\\":{\\\"address\\\":{\\\"city\\\":\\\"北京市\\\",\\\"detail\\\":\\\"花家地社区卫生服务站\\\",\\\"district\\\":\\\"朝阳区\\\",\\\"province\\\":\\\"北京\\\",\\\"town\\\":\\\"望京街道\\\"},\\\"mobile\\\":\\\"1326443654\\\",\\\"name\\\":\\\"Bar\\\",\\\"phone\\\":\\\"057123222\\\"},\\\"routingInfo\\\":{\\\"consolidation\\\":{},\\\"origin\\\":{\\\"code\\\":\\\"POSTB\\\"},\\\"sortation\\\":{\\\"name\\\":\\\"杭州\\\"}},\\\"dmsSortingInfo\\\": {\\\"siteAreaCode\\\": \\\"A2\\\"},\\\"sender\\\":{\\\"address\\\":{\\\"city\\\":\\\"北京市\\\",\\\"detail\\\":\\\"花家地社区卫生服务站\\\",\\\"district\\\":\\\"朝阳区\\\",\\\"province\\\":\\\"北京\\\",\\\"town\\\":\\\"望京街道\\\"},\\\"mobile\\\":\\\"1326443654\\\",\\\"name\\\":\\\"Bar\\\",\\\"phone\\\":\\\"057123222\\\"},\\\"shippingOption\\\":{\\\"code\\\":\\\"COD\\\",\\\"services\\\":{\\\"SVC-COD\\\":{\\\"value\\\":\\\"200\\\"}},\\\"title\\\":\\\"代收货款\\\"},\\\"waybillCode\\\":\\\"9890000160004\\\"},\\\"signature\\\":\\\"RSA:hqUkugCY2FFXJK10fRcUE0TsvDppxXuBdOEnPVntF3u4H2yaYiPsPXqjdI1C5oXs60vVCfqd8YC6vZx57TnN9\/u0VYM\/TiFmMtxix9ouPQ2p7G64UyX9BrnRQQCp5ETqJogSzIpxVlz5rx3hy19C+VQrqWgQEw5JqOkoBFXhMi8\\u003d\\\",\\\"templateURL\\\":\\\"http:\/\/cloudprint.cainiao.com\/cloudprint\/template\/getStandardTemplate.json?template_id\\u003d1001\\\"}",
"parent_waybill_code":"9890000160004"
}
]
"recipient": {
"address": {
"detail": "牛牛县大洋区洋洋街道32号11栋1单元403号",
"province": "河南省"
},
"name": "张三"
"mobile": "13913231777"
}
}
}
}
响应代码
代码代码描述解决方案
0成功
100请求参数错误检查您的请求参数是否正确
101请求超时，请重试检查您的网络情况或者联系客服解决
200系统错误，请联系客服检查您的接口地址填写是否正确，其他问题联系客服解决
202系统错误，请稍后再试稍后重试，或者联系对接群
203暂不支持当前接口
204请求异常：无该接口权限，请前往官网开通正式接口。前往官网开通该接口权限
204请求异常：API 调用次数不足，请前往网站兑换次数。前往官网充值该接口调用次数
302未授权店铺根据返回链接进行扫码授权
401身份凭证无效在请求头中添加 access_token，重新更新 token
404请求路径或请求方式错误请更换请求方式或者检查路径是否正确
614生成面单号出现未知异常重试或联系电子面单技术支持
614账户余额不足请联系快递网点充值
614发货地址没有匹配的电子面单服务请检查取号时的发货地址是否商家订购的地址，可通过订购关系查询接口获取
614字段长度超过限制请参见白皮书字段长度限制
614必选字段不能为空请检查代码
614字段长度超过限制请参见白皮书字段长度限制
614物品个数必须大于 0请检查代码
614字段长度超过限制请参见白皮书字段长度限制
614必选字段不能为空，收件人电话和收件人手机至少要有一个。请检查代码
614必选字段不能为空请检查代码
614必选字段不能为空请检查代码
614商家请求参数非法，同一个交易订单不能申请多个网点的面单检查参数是否错误，或取消操作
614必选字段不能为空请检查代码
614必选字段不能为空请检查代码
614面单订购服务不存在确认是否已订购，已订购请联系菜鸟排查
614商家请求参数错误，申请的交易订单和已经存在的交易订单号存在交叉检查入参是否错误
614订单号出现重复检查入参
614商品名称太长(最长 128)检查入参的商品名称长度，缩减长度
614必选字段不能为空请检查代码
614模板 URL 格式错误检查入参的云打印模板 URL 是否合法
614必选字段不能为空请检查代码
614收货地址城市信息过长(最长 20)检查参数中收货人城市信息长度，缩减长度
614object id 不能重复检查入参是否错误
614商家请求参数非法，交易订单号太长(最长为 40)检查入参是否错误
614商家请求参数非法，交易订单号包含非 ASCII 字符检查参数是否错误
614收货人姓名长度超过限制(最长 40)检查参数中收货人姓名长度，缩减长度
614收货地址省份信息过长(最长 20)检查参数中收货人省份信息长度，缩减长度
614找不到服务描述入参的 product_code 字段请不要传任何值
614必选字段不能为空请检查代码
614收货地址长度太长请减少收货详细地址长度
614ERP 订单号/包裹号包含非 ASCII 字符检查入参
614必选字段不能为空请检查代码
614发件人手机号长度超过限制(最大长度 20)检查入参中发件人的手机号是否错误
614模板 URL 错误，需要菜鸟域名检查入参
614发件人固话长度超过限制(最长 20)检查参数中收货人固话长度，缩减长度
614必选字段不能为空请检查代码
614收货地址城镇信息过长(最长 30)检查参数中收货人城镇信息长度，缩减长度
614收货地址详细地址信息过长减少详细地址长度
614ERP 订单号/包裹号太长PackageId 长度限制 40 个字符
614模板 URL 错误，没有找到对应模板 URL检查入参，确认模板 URL 是否正确
614请求的面单交易来源信息非法，请只用指定的渠道来源值查看接入文档中的订单渠道枚举值
614当前传入的快递公司编号代表的快递公司打印服务暂不开放检查 cpCode 是否错误，或开通服务
614物流服务能力值不是有效的 JSON 格式检查入参
614必选字段不能为空请检查代码
614发件人姓名长度超过限制(最大长度 40)检查入参的发件人姓名是否超长
614订单渠道不能为空请检查代码
614cpCode, cpId 不能同时为空检查入参
614商家没有订购物流服务访问卖家中心，订购对应的物流服务，并联系对应快递公司网点审核通过。
614物流服务传值错误联系对应软件服务商，按照菜鸟接口对接标准透传服务。
614系统临时错误稍候重试
614对应物流服务不允许批量取号联系软件商修改接口调用方式
614该订单超出物流商承运范围联系当地物流承运商
614无效的 OAID根据错误消息中的 tid 列表，调用 taobao.trade.fullinfo.get 获取最新的 OAID。错误消息格式类似"参数 oaid 无效，tid:123,456,789"。
作者：v兔 链接：http://ask.vv-tool.com 来源：v兔电商知识库 著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
- 发表于 01/05/2022 18:13:06
- 阅读 ( 752 )
- 分类：API接口
