文档中心 > API类目 > 菜鸟裹裹API

cainiao.guoguo.waybill.get (菜鸟裹裹商家寄件取号接口)

菜鸟裹裹商家寄件取号接口

公共参数

请求参数

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

响应参数

名称 类型 示例值 描述
modules WaybillCloudPrintNewResponse [] 系统自动生成
  • └ 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": ""}
  • 拓展信息,特殊场景下使用
  • └ cp_code
  • String
  • STO
  • cp_code,跟入参传入的cp_code保持一致
  • └ real_cp_code
  • String
  • STO
  • 真实取号的cp_code,在菜鸟裹裹商家寄件等虚拟cp的场景中real_cp_code和入参中的cp_code不一样,其他场景二者一样
  • └ is_success
  • Boolean
  • true
  • 本单请求是否成功
  • └ object_id
  • String
  • 12
  • 请求id
  • └ error_code
  • String
  • SYS_ERROR
  • 错误码
  • └ error_message
  • String
  • 系统错误
  • 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoWaybillGetRequest req = new CainiaoGuoguoWaybillGetRequest();
CainiaoGuoguoWaybillGetRequest.WaybillCloudPrintApplyNewRequest obj1 = new CainiaoGuoguoWaybillGetRequest.WaybillCloudPrintApplyNewRequest();
obj1.setCpCode("POSTB");
obj1.setDoorPickUpEndTime("2021-08-07 12:34:30");
obj1.setThreePlTiming(false);
obj1.setCustomerCode("adb123345");
obj1.setShippingBranchCode("10001");
obj1.setNeedEncrypt(false);
obj1.setProductCode("目前仅顺丰场景支持此字段,传入快递产品编码");
obj1.setResourceCode("DISTRIBUTOR_978324");
obj1.setDoorPickUpTime("2021-08-07 12:34:30");
CainiaoGuoguoWaybillGetRequest.UserInfoDTO obj2 = new CainiaoGuoguoWaybillGetRequest.UserInfoDTO();
CainiaoGuoguoWaybillGetRequest.AddressDTO obj3 = new CainiaoGuoguoWaybillGetRequest.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<CainiaoGuoguoWaybillGetRequest.TradeOrderInfoDTO> list5 = new ArrayList<CainiaoGuoguoWaybillGetRequest.TradeOrderInfoDTO>();
CainiaoGuoguoWaybillGetRequest.TradeOrderInfoDTO obj6 = new CainiaoGuoguoWaybillGetRequest.TradeOrderInfoDTO();
list5.add(obj6);
obj6.setLogisticsServices("如不需要特殊服务,该值为空");
CainiaoGuoguoWaybillGetRequest.UserInfoDTO obj8 = new CainiaoGuoguoWaybillGetRequest.UserInfoDTO();
CainiaoGuoguoWaybillGetRequest.AddressDTO obj9 = new CainiaoGuoguoWaybillGetRequest.AddressDTO();
obj9.setProvince("北京");
obj9.setTown("望京街道");
obj9.setCity("北京市");
obj9.setDistrict("朝阳区");
obj9.setDetail("花家地社区卫生服务站");
obj8.setAddress(obj9);
obj8.setPhone("057123222");
obj8.setCaid("As268woscee");
obj8.setName("Bar");
obj8.setMobile("1326443654");
obj8.setOaid("abcdefghijk");
obj8.setTid("1527014522198024829");
list7.setRecipient(obj8);
CainiaoGuoguoWaybillGetRequest.OrderInfoDTO obj11 = new CainiaoGuoguoWaybillGetRequest.OrderInfoDTO();
obj11.setOutTradeSubOrderList("12,34,56,78");
obj11.setOrderChannelsType("TB");
obj11.setOutTradeOrderList("123456,456789");
obj11.setTradeOrderList("1222221");
list10.setOrderInfo(obj11);
obj6.setWaybillCode("SF982933200");
CainiaoGuoguoWaybillGetRequest.PackageInfoDTO obj13 = new CainiaoGuoguoWaybillGetRequest.PackageInfoDTO();
obj13.setLength(30L);
obj13.setPackagingDescription("5纸3木2拖");
obj13.setWeight(1L);
obj13.setTotalPackagesCount(10L);
obj13.setVolume(1L);
obj13.setWidth(30L);
List<CainiaoGuoguoWaybillGetRequest.Item> list15 = new ArrayList<CainiaoGuoguoWaybillGetRequest.Item>();
CainiaoGuoguoWaybillGetRequest.Item obj16 = new CainiaoGuoguoWaybillGetRequest.Item();
list15.add(obj16);
obj16.setName("衣服");
obj16.setCount(1L);
obj13.setItems(list15);
obj13.setId("1");
obj13.setGoodsDescription("服装");
obj13.setHeight(50L);
obj13.setGoodValue("34.3");
list12.setPackageInfo(obj13);
obj6.setUserId(12L);
obj6.setTemplateUrl("http://cloudprint.cainiao.com/template/standard/101");
obj6.setObjectId("1");
obj1.setTradeOrderInfoDtos(list5);
obj1.setDmsSorting(false);
obj1.setBrandCode("FOP");
obj1.setExtraInfo("{\"isvClientCode\": \"ab12344\"}");
obj1.setMultiPackagesShipment(false);
obj1.setStoreCode("553323");
obj1.setCallDoorPickUp(false);
req.setParamWaybillCloudPrintApplyNewRequest(obj1);
CainiaoGuoguoWaybillGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_guoguo_waybill_get_response>
    <modules>
        <waybill_cloud_print_new_response>
            <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>
            <cp_code>STO</cp_code>
            <real_cp_code>STO</real_cp_code>
            <is_success>true</is_success>
            <object_id>12</object_id>
            <error_code>SYS_ERROR</error_code>
            <error_message>系统错误</error_message>
        </waybill_cloud_print_new_response>
    </modules>
</cainiao_guoguo_waybill_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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部