文档中心 > API类目 > 电子面单API

cainiao.waybill.ii.inner.get (电子面单云打印接口(内部))

电子面单内部应用的云打印取号接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
seller_id Number 必须 3892269560 取号商家id
param_waybill_cloud_print_apply_new_request WaybillCloudPrintApplyNewRequest 必须 入参信息
  • └ product_code
  • String
  • 可选
  • 目前已经不推荐使用此字段,请不要使用
  • 目前已经不推荐使用此字段,请不要使用
  • sender
  • UserInfoDto
  • 必须
  • 发货人信息
  • address
  • AddressDto
  • 必须
  • 发货地址需要通过search接口
  • └ city
  • String
  • 可选
  • 北京市
  • 城市,长度小于20
  • └ detail
  • String
  • 必须
  • 花家地社区卫生服务站
  • 详细地址,长度小于256
  • └ district
  • String
  • 可选
  • 朝阳区
  • 区,长度小于20
  • └ province
  • String
  • 必须
  • 北京
  • 省,长度小于20
  • └ town
  • String
  • 可选
  • 望京街道
  • 街道,长度小于30
  • └ mobile
  • String
  • 可选
  • 1326443654
  • 手机号码(手机号和固定电话不能同时为空),长度小于20
  • └ name
  • String
  • 必须
  • Bar
  • 姓名,长度小于40
  • └ phone
  • String
  • 可选
  • 057123222
  • 固定电话(手机号和固定电话不能同时为空),长度小于20
  • trade_order_info_dtos
  • TradeOrderInfoDto []
  • 必须
  • 请求面单信息,数量限制为10
  • └ logistics_services
  • String
  • 可选
  • 如不需要特殊服务,该值为空
  • 物流服务值(详见https://support-cnkuaidi.taobao.com/doc.htm#?docId=106156&docType=1,如无特殊服务请置空)
  • └ object_id
  • String
  • 必须
  • 1
  • 请求ID
  • order_info
  • OrderInfoDto
  • 必须
  • 订单信息
  • └ trade_order_list
  • String []
  • 必须
  • 1222221
  • 订单号,数量限制100,订单号(只限传入数字、字母、下划线和中划线,为避免出现冲突,请按电商平台真实订单号传入,请避免使用同个订单号重复取号)
  • └ out_trade_order_list
  • String []
  • 可选
  • 123456,456789
  • 外部电商平台交易单号集合,非必填,数量限制100
  • └ out_trade_sub_order_list
  • String []
  • 可选
  • 12,34,56,78
  • 外部电商平台交易子单号集合,非必填,数量限制100
  • package_info
  • PackageInfoDto
  • 必须
  • 包裹信息
  • └ id
  • String
  • 可选
  • 1
  • 包裹id,用于拆合单场景(只能传入数字、字母和下划线;批量请求时值不得重复,大小写敏感,即123A,123a 不可当做不同ID,否则存在一定可能取号失败)
  • items
  • Item []
  • 必须
  • 商品信息,数量限制为100
  • └ count
  • Number
  • 必须
  • 1
  • 数量
  • └ name
  • String
  • 必须
  • 衣服
  • 名称
  • └ volume
  • Number
  • 可选
  • 1
  • 体积, 单位 ml
  • └ weight
  • Number
  • 可选
  • 1
  • 重量,单位 g
  • └ total_packages_count
  • Number
  • 可选
  • 10
  • 子母件模式中的总包裹数/总件数,用于打印当前包裹处于总件数的位置比如5-2,可以表示总包裹数为5,当前为第2个包裹,只有快运公司需要传入,其他的可以不用传入
  • └ packaging_description
  • String
  • 可选
  • 5纸3木2拖
  • 大件快运中的包装方式描述
  • └ goods_description
  • String
  • 可选
  • 服装
  • 大件快运中的货品描述,比如服装,家具
  • └ length
  • Number
  • 可选
  • 30
  • 包裹长,单位厘米
  • └ width
  • Number
  • 可选
  • 30
  • 包裹宽,单位厘米
  • └ height
  • Number
  • 可选
  • 50
  • 包裹高,单位厘米
  • └ good_value
  • String
  • 可选
  • 34.3
  • 物品价值,单位元
  • recipient
  • RecipientInfoDto
  • 必须
  • 收件人信息
  • address
  • AddressDto
  • 必须
  • 地址
  • └ city
  • String
  • 可选
  • 北京市
  • 城市
  • └ detail
  • String
  • 必须
  • 花家地社区卫生服务站
  • 详细地址
  • └ district
  • String
  • 可选
  • 朝阳区
  • └ province
  • String
  • 必须
  • 北京
  • └ town
  • String
  • 可选
  • 望京街道
  • 街道
  • └ mobile
  • String
  • 可选
  • 1326443654
  • 手机号码
  • └ name
  • String
  • 必须
  • Bar
  • 姓名
  • └ phone
  • String
  • 可选
  • 057123222
  • 固定电话
  • └ oaid
  • String
  • 可选
  • abcdefghijk
  • 淘宝订单收件人ID (Open Addressee ID),长度不超过128个字符,淘宝订单加密情况用于解密。
  • └ tid
  • String
  • 可选
  • 1527014522198024829
  • 电商平台真实交易订单号,针对电商平台订单隐私加密场景使用,非必填,如果填写则必须是电商平台真实的交易订单ID
  • └ caid
  • String
  • 可选
  • As268woscee
  • 菜鸟解密地址ID,用于电商平台收件人信息加密的场景使用,非订单加密场景请勿使用。
  • └ template_url
  • String
  • 必须
  • http://cloudprint.cainiao.com/template/standard/101
  • 云打印标准模板URL(组装云打印结果使用,值格式http://cloudprint.cainiao.com/template/standard/${模板ID})
  • └ user_id
  • Number
  • 必须
  • 12
  • 使用者ID(使用电子面单账号的实际商家ID,如存在一个电子面单账号多个店铺使用时,请传入店铺的商家ID)
  • └ extra_info
  • String
  • 可选
  • {"ttNoDecison": "1"}
  • 扩展参数
  • └ store_code
  • String
  • 可选
  • 553323
  • 仓code, 仓库WMS系统对接落地配业务,其它场景请不要使用
  • └ resource_code
  • String
  • 可选
  • DISTRIBUTOR_978324
  • 配送资源code, 仓库WMS系统对接落地配业务,其它场景请不要使用
  • └ dms_sorting
  • Boolean
  • 可选
  • false
  • 是否使用智分宝预分拣, 仓库WMS系统对接落地配业务,其它场景请不要使用
  • └ three_pl_timing
  • Boolean
  • 可选
  • false
  • 订单上是否带3PLtiming属性, 该属性需要严格与订单上属性保持一致,如果不确定,请使用默认false。
  • └ need_encrypt
  • Boolean
  • 可选
  • false
  • 设定取号返回的云打印报文是否加密
  • └ multi_packages_shipment
  • Boolean
  • 可选
  • false
  • 快递公司支持一票多件,快运公司子母件请勿使用该参数
  • └ brand_code
  • String
  • 可选
  • SF_FOP
  • 品牌编码
  • └ extra_info
  • String
  • 可选
  • {"isvClientCode": "ab12344"}
  • 扩展参数
  • └ customer_code
  • String
  • 可选
  • adb123345
  • 月结卡号
  • └ call_door_pick_up
  • Boolean
  • 可选
  • false
  • 是否预约上门
  • └ door_pick_up_time
  • String
  • 可选
  • 2021-08-07 12:34:30
  • 预约上门收件时间
  • └ door_pick_up_end_time
  • String
  • 可选
  • 2021-08-07 12:34:30
  • 预约上门截止时间
  • └ shipping_branch_code
  • String
  • 可选
  • ZTO
  • 寄件网点编码
param_client_info_for_top ClientInfoForTopDto 可选 系统自动生成
  • └ app_name
  • String
  • 必须
  • waybill
  • 调用来源应用appname

响应参数

名称 类型 示例值 描述
modules WaybillCloudPrintResponse [] xx 系统自动生成
  • └ object_id
  • String
  • 12
  • 请求id
  • └ print_data
  • String
  • {\"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\"}
  • 云打印内容(encryptedData表示加密结果,data表示非加密结果);模板内容,具体解释见链接
  • └ waybill_code
  • String
  • 9890000160004
  • 面单号, 子母件模式下为子面单号
  • └ parent_waybill_code
  • String
  • 9890000160004
  • 子母件中的母单号,当为子母件模式时,需要此单号为实际挂载物流详情的单号,需要使用此单号进行发货,查询物流详情,非子母件,此字段为空
  • └ extra_info
  • String
  • {"remark": ""}
  • 拓展信息,特殊场景下使用
  • └ real_cp_code
  • String
  • STO
  • 真实取号的cp_code,在淘特官方物流等虚拟cp的场景中real_cp_code和入参中的cp_code不一样,其他场景二者一样
  • └ cp_code
  • String
  • STO
  • cp_code,跟入参传入的cp_code保持一致

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoWaybillIiInnerGetRequest req = new CainiaoWaybillIiInnerGetRequest();
req.setSellerId(3892269560L);
CainiaoWaybillIiInnerGetRequest.WaybillCloudPrintApplyNewRequest obj1 = new CainiaoWaybillIiInnerGetRequest.WaybillCloudPrintApplyNewRequest();
obj1.setCpCode("POSTB");
obj1.setProductCode("目前已经不推荐使用此字段,请不要使用");
CainiaoWaybillIiInnerGetRequest.UserInfoDto obj2 = new CainiaoWaybillIiInnerGetRequest.UserInfoDto();
CainiaoWaybillIiInnerGetRequest.AddressDto obj3 = new CainiaoWaybillIiInnerGetRequest.AddressDto();
obj3.setCity("北京市");
obj3.setDetail("花家地社区卫生服务站");
obj3.setDistrict("朝阳区");
obj3.setProvince("北京");
obj3.setTown("望京街道");
obj2.setAddress(obj3);
obj2.setMobile("1326443654");
obj2.setName("Bar");
obj2.setPhone("057123222");
obj1.setSender(obj2);
List<CainiaoWaybillIiInnerGetRequest.TradeOrderInfoDto> list5 = new ArrayList<CainiaoWaybillIiInnerGetRequest.TradeOrderInfoDto>();
CainiaoWaybillIiInnerGetRequest.TradeOrderInfoDto obj6 = new CainiaoWaybillIiInnerGetRequest.TradeOrderInfoDto();
list5.add(obj6);
obj6.setLogisticsServices("如不需要特殊服务,该值为空");
obj6.setObjectId("1");
CainiaoWaybillIiInnerGetRequest.OrderInfoDto obj8 = new CainiaoWaybillIiInnerGetRequest.OrderInfoDto();
obj8.setOrderChannelsType("TB");
obj8.setTradeOrderList("1222221");
obj8.setOutTradeOrderList("123456,456789");
obj8.setOutTradeSubOrderList("12,34,56,78");
list7.setOrderInfo(obj8);
CainiaoWaybillIiInnerGetRequest.PackageInfoDto obj10 = new CainiaoWaybillIiInnerGetRequest.PackageInfoDto();
obj10.setId("1");
List<CainiaoWaybillIiInnerGetRequest.Item> list12 = new ArrayList<CainiaoWaybillIiInnerGetRequest.Item>();
CainiaoWaybillIiInnerGetRequest.Item obj13 = new CainiaoWaybillIiInnerGetRequest.Item();
list12.add(obj13);
obj13.setCount(1L);
obj13.setName("衣服");
obj10.setItems(list12);
obj10.setVolume(1L);
obj10.setWeight(1L);
obj10.setTotalPackagesCount(10L);
obj10.setPackagingDescription("5纸3木2拖");
obj10.setGoodsDescription("服装");
obj10.setLength(30L);
obj10.setWidth(30L);
obj10.setHeight(50L);
obj10.setGoodValue("34.3");
list9.setPackageInfo(obj10);
CainiaoWaybillIiInnerGetRequest.RecipientInfoDto obj15 = new CainiaoWaybillIiInnerGetRequest.RecipientInfoDto();
CainiaoWaybillIiInnerGetRequest.AddressDto obj16 = new CainiaoWaybillIiInnerGetRequest.AddressDto();
obj16.setCity("北京市");
obj16.setDetail("花家地社区卫生服务站");
obj16.setDistrict("朝阳区");
obj16.setProvince("北京");
obj16.setTown("望京街道");
obj15.setAddress(obj16);
obj15.setMobile("1326443654");
obj15.setName("Bar");
obj15.setPhone("057123222");
obj15.setOaid("abcdefghijk");
obj15.setTid("1527014522198024829");
obj15.setCaid("As268woscee");
list14.setRecipient(obj15);
obj6.setTemplateUrl("http://cloudprint.cainiao.com/template/standard/101");
obj6.setUserId(12L);
obj6.setExtraInfo("{\"ttNoDecison\": \"1\"}");
obj1.setTradeOrderInfoDtos(list5);
obj1.setStoreCode("553323");
obj1.setResourceCode("DISTRIBUTOR_978324");
obj1.setDmsSorting(false);
obj1.setThreePlTiming(false);
obj1.setNeedEncrypt(false);
obj1.setMultiPackagesShipment(false);
obj1.setBrandCode("SF_FOP");
obj1.setExtraInfo("{\"isvClientCode\": \"ab12344\"}");
obj1.setCustomerCode("adb123345");
obj1.setCallDoorPickUp(false);
obj1.setDoorPickUpTime("2021-08-07 12:34:30");
obj1.setDoorPickUpEndTime("2021-08-07 12:34:30");
obj1.setShippingBranchCode("ZTO");
req.setParamWaybillCloudPrintApplyNewRequest(obj1);
CainiaoWaybillIiInnerGetRequest.ClientInfoForTopDto obj17 = new CainiaoWaybillIiInnerGetRequest.ClientInfoForTopDto();
obj17.setAppName("waybill");
req.setParamClientInfoForTop(obj17);
CainiaoWaybillIiInnerGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_waybill_ii_inner_get_response>
    <modules>
        <waybill_cloud_print_response>
            <object_id>12</object_id>
            <print_data>{\&quot;data\&quot;:{\&quot;recipient\&quot;:{\&quot;address\&quot;:{\&quot;city\&quot;:\&quot;北京市\&quot;,\&quot;detail\&quot;:\&quot;花家地社区卫生服务站\&quot;,\&quot;district\&quot;:\&quot;朝阳区\&quot;,\&quot;province\&quot;:\&quot;北京\&quot;,\&quot;town\&quot;:\&quot;望京街道\&quot;},\&quot;mobile\&quot;:\&quot;1326443654\&quot;,\&quot;name\&quot;:\&quot;Bar\&quot;,\&quot;phone\&quot;:\&quot;057123222\&quot;},\&quot;routingInfo\&quot;:{\&quot;consolidation\&quot;:{},\&quot;origin\&quot;:{\&quot;code\&quot;:\&quot;POSTB\&quot;},\&quot;sortation\&quot;:{\&quot;name\&quot;:\&quot;杭州\&quot;}},\&quot;dmsSortingInfo\&quot;: {\&quot;siteAreaCode\&quot;: \&quot;A2\&quot;},\&quot;sender\&quot;:{\&quot;address\&quot;:{\&quot;city\&quot;:\&quot;北京市\&quot;,\&quot;detail\&quot;:\&quot;花家地社区卫生服务站\&quot;,\&quot;district\&quot;:\&quot;朝阳区\&quot;,\&quot;province\&quot;:\&quot;北京\&quot;,\&quot;town\&quot;:\&quot;望京街道\&quot;},\&quot;mobile\&quot;:\&quot;1326443654\&quot;,\&quot;name\&quot;:\&quot;Bar\&quot;,\&quot;phone\&quot;:\&quot;057123222\&quot;},\&quot;shippingOption\&quot;:{\&quot;code\&quot;:\&quot;COD\&quot;,\&quot;services\&quot;:{\&quot;SVC-COD\&quot;:{\&quot;value\&quot;:\&quot;200\&quot;}},\&quot;title\&quot;:\&quot;代收货款\&quot;},\&quot;waybillCode\&quot;:\&quot;9890000160004\&quot;},\&quot;signature\&quot;:\&quot;RSA:hqUkugCY2FFXJK10fRcUE0TsvDppxXuBdOEnPVntF3u4H2yaYiPsPXqjdI1C5oXs60vVCfqd8YC6vZx57TnN9/u0VYM/TiFmMtxix9ouPQ2p7G64UyX9BrnRQQCp5ETqJogSzIpxVlz5rx3hy19C+VQrqWgQEw5JqOkoBFXhMi8\u003d\&quot;,\&quot;templateURL\&quot;:\&quot;http://cloudprint.cainiao.com/cloudprint/template/getStandardTemplate.json?template_id\u003d1001\&quot;}</print_data>
            <waybill_code>9890000160004</waybill_code>
            <parent_waybill_code>9890000160004</parent_waybill_code>
            <extra_info>{&quot;remark&quot;: &quot;&quot;}</extra_info>
            <real_cp_code>STO</real_cp_code>
            <cp_code>STO</cp_code>
        </waybill_cloud_print_response>
    </modules>
</cainiao_waybill_ii_inner_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
isp.WAYBILL_APPLY_NEW_ERROR 生成面单号出现未知异常 重试或联系电子面单技术支持
waybill account not enough 账户余额不足 请联系快递网点充值
shipping address cannot match any service 发货地址没有匹配的电子面单服务 请检查取号时的发货地址是否商家订购的地址,可通过订购关系查询接口获取
phone of consignee too long 字段长度超过限制 请参见白皮书字段长度限制
province of consigneeAddress can not be null 必选字段不能为空 请检查代码
mobile of consignee too long 字段长度超过限制 请参见白皮书字段长度限制
package item count must be greate than zero 物品个数必须大于0 请检查代码
consignee_address_area_too_long 字段长度超过限制 请参见白皮书字段长度限制
consigneePhone and consigneeMobile can not be both null 必选字段不能为空,收件人电话和收件人手机至少要有一个。 请检查代码
detail consigneeAddress can not be null 必选字段不能为空 请检查代码
sendPhone and sendMobile can not be both null 必选字段不能为空 请检查代码
trade order can not apply mutil branch account 商家请求参数非法,同一个交易订单不能申请多个网点的面单 检查参数是否错误,或取消操作
name of consignee can not be null 必选字段不能为空 请检查代码
trade item into can not be null 必选字段不能为空 请检查代码
subscribe service not found 面单订购服务不存在 确认是否已订购,已订购请联系菜鸟排查
request bizOrderCode has cross for exist! 商家请求参数错误,申请的交易订单和已经存在的交易订单号存在交叉 检查入参是否错误
trade order can not duplicate 订单号出现重复 检查入参
trade item name too long 商品名称太长(最长128) 检查入参的商品名称长度,缩减长度
package item name can not be null 必选字段不能为空 请检查代码
templateURL error 模板URL格式错误 检查入参的云打印模板URL是否合法
sendName can not be null 必选字段不能为空 请检查代码
consignee_address_city_too_long 收货地址城市信息过长(最长20) 检查参数中收货人城市信息长度,缩减长度
object Id duplicate object id 不能重复 检查入参是否错误
trade order code too long 商家请求参数非法,交易订单号太长(最长为40) 检查入参是否错误
trade order code has non-ascii char 商家请求参数非法,交易订单号包含非ASCII字符 检查参数是否错误
name of consignee too long 收货人姓名长度超过限制(最长40) 检查参数中收货人姓名长度,缩减长度
consignee_address_province_too_long 收货地址省份信息过长(最长20) 检查参数中收货人省份信息长度,缩减长度
service description not found 找不到服务描述 入参的product_code字段请不要传任何值
province of shippingAddress can not be null 必选字段不能为空 请检查代码
consignee address too long 收货地址长度太长 请减少收货详细地址长度
package_id has non-ascii char ERP订单号/包裹号包含非ASCII字符 检查入参
trade order code can not be null 必选字段不能为空 请检查代码
mobile of send too long 发件人手机号长度超过限制(最大长度20) 检查入参中发件人的手机号是否错误
templateURL host error 模板URL错误,需要菜鸟域名 检查入参
phone of send too long 发件人固话长度超过限制(最长20) 检查参数中收货人固话长度,缩减长度
objectId can not be null 必选字段不能为空 请检查代码
consignee_address_town_too_long 收货地址城镇信息过长(最长30) 检查参数中收货人城镇信息长度,缩减长度
consignee_address_detail_too_long 收货地址详细地址信息过长 减少详细地址长度
package_id too long ERP订单号/包裹号太长 PackageId长度限制40个字符
templateURL url not found 模板URL错误,没有找到对应模板URL 检查入参,确认模板URL是否正确
request order channels invalid! 请求的面单交易来源信息非法,请只用指定的渠道来源值 查看接入文档中的订单渠道枚举值
waybill service cannot open 当前传入的快递公司编号代表的快递公司打印服务暂不开放 检查cpCode是否错误,或开通服务
logistics service value illegal for json 物流服务能力值不是有效的json格式 检查入参
detail shippingAddress can not be null 必选字段不能为空 请检查代码
name of send too long 发件人姓名长度超过限制(最大长度40) 检查入参的发件人姓名是否超长
trade order channel can not be null 订单渠道不能为空 请检查代码
cpcode or cpId can not both be null cpCode, cpId不能同时为空 检查入参
the seller didnt subscribe such service 商家没有订购物流服务 访问卖家中心,订购对应的物流服务,并联系对应快递公司网点审核通过。
logistics services validation failure 物流服务传值错误 联系对应软件服务商,按照菜鸟接口对接标准透传服务。
system default error 系统临时错误 稍候重试
service doesnt allow batch request 对应物流服务不允许批量取号 联系软件商修改接口调用方式
PACKAGE_NOT_REACHABLE 该订单超出物流商承运范围 联系当地物流承运商
isv.oaid-invalid 无效的OAID 根据错误消息中的tid列表,调用taobao.trade.fullinfo.get获取最新的OAID。错误消息格式类似"参数oaid无效,tid:123,456,789"。

API工具

如何获得此API

FAQ

返回
顶部