taobao.cainiao.order.logistics.consign (统一发货)

统一发货

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
consign_top_request ConsignTopRequestDto 必须 发货request
  • └ confirm_consign
  • Boolean
  • 必须
  • false
  • 如果true,调用接口后,阿里系交易订单状态将变成“已发货”,out_trade_id必须阿里系交易ID; 如果false,需要商家自己调用确认发货接口。默认值为false
  • └ app_name
  • String
  • 必须
  • appkey123
  • ERP的对应名唯一key
  • consign_info
  • ConsignTopInfoDto
  • 必须
  • 发货单基本数据
  • store_service_dto
  • StoreServiceDto
  • 可选
  • 仓服务
  • └ store_code
  • String
  • 可选
  • WH001
  • 【必选】仓code 若为default 表示菜鸟路由 否则商家指定仓
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • receiver_contact
  • ConsignContactDto
  • 必须
  • 收货地址信息,若没有默认是订单上面默认地址;若是填写,覆盖原有地址 若是外部订单,必须填写
  • └ contact_id
  • Number
  • 可选
  • 123456
  • 联系人地址唯一标识 (若传ID,则从商家地址库获取ID)
  • └ mobile_phone
  • String
  • 可选
  • 13322224444
  • 手机(电话或手机号必须填写1个)
  • └ ddd
  • String
  • 可选
  • 0571
  • 区号
  • └ remark
  • String
  • 可选
  • 备注
  • 备注
  • └ address
  • String
  • 可选
  • 浙江省杭州市西湖区文二路398号
  • 详细地址, 格式: 浙江省杭州市西湖区文二路398号
  • └ wangwang_id
  • String
  • 可选
  • XXX店铺
  • 联系人旺旺
  • └ contact_name
  • String
  • 可选
  • 郭德纲
  • 联系人姓名
  • └ zip_code
  • String
  • 可选
  • 123000
  • 邮编
  • └ branch
  • String
  • 可选
  • 890
  • 分机号
  • └ telephone
  • String
  • 可选
  • 88602334
  • 座机号(电话或手机号必须填写1个)
  • └ area_id
  • Number
  • 可选
  • 330106
  • 地区ID(3级地址库ID) (建议传ID可以精确匹配到地址)
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • └ remark
  • String
  • 可选
  • 备注
  • 备注
  • appoint_service_dto
  • AppointServiceDto
  • 可选
  • 预约配送服务
  • └ os_date
  • String
  • 可选
  • 20150518
  • 预约日期yyyyMMdd
  • └ os_range
  • String
  • 可选
  • 09:00-18:00
  • 预约配送时段09:00-18:00
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • sender_contact
  • ConsignContactDto
  • 必须
  • 发货地址信息,没有默认就是地址
  • └ contact_id
  • Number
  • 可选
  • 123456
  • 联系人地址唯一标识 (若传ID,则从商家地址库获取ID)
  • └ mobile_phone
  • String
  • 可选
  • 13322224444
  • 手机(电话或手机号必须填写1个)
  • └ ddd
  • String
  • 可选
  • 0571
  • 区号
  • └ remark
  • String
  • 可选
  • 备注
  • 备注
  • └ address
  • String
  • 可选
  • 浙江省杭州市西湖区文二路398号
  • 详细地址, 格式: 浙江省杭州市西湖区文二路398号
  • └ wangwang_id
  • String
  • 可选
  • XXX店铺
  • 联系人旺旺
  • └ contact_name
  • String
  • 可选
  • 郭德纲
  • 联系人姓名
  • └ zip_code
  • String
  • 可选
  • 123000
  • 邮编
  • └ branch
  • String
  • 可选
  • 890
  • 分机号
  • └ telephone
  • String
  • 可选
  • 88602334
  • 座机号(电话或手机号必须填写1个)
  • └ area_id
  • Number
  • 可选
  • 330106
  • 地区ID(3级地址库ID) (建议传ID可以精确匹配到地址)
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • └ out_trade_no
  • String
  • 必须
  • 123456
  • 交易订单id,或者分销采购单号; 若阿里系订单,必须与阿里对应 最大64
  • └ consign_type
  • Number
  • 必须
  • 0
  • 0 : 商家自己联系(线下快递公司) 1: 菜鸟在线发货(菜鸟配或者菜鸟仓发货)
  • invoince_service_dto
  • InvoinceServiceDto
  • 可选
  • 发票服务
  • └ bill_type
  • Number
  • 可选
  • 1
  • 发票类型:1=增值税发票,2=营业税发票
  • └ bill_title
  • String
  • 可选
  • XXX公司
  • 发票抬头
  • └ bill_amount
  • Number
  • 可选
  • 100
  • 发票金额
  • └ bill_content
  • String
  • 可选
  • 发票内容
  • 发票内容
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • refund_contact
  • ConsignContactDto
  • 必须
  • 退货地址信息,没有默认就是地址
  • └ contact_id
  • Number
  • 可选
  • 123456
  • 联系人地址唯一标识 (若传ID,则从商家地址库获取ID)
  • └ mobile_phone
  • String
  • 可选
  • 13322224444
  • 手机(电话或手机号必须填写1个)
  • └ ddd
  • String
  • 可选
  • 0571
  • 区号
  • └ remark
  • String
  • 可选
  • 备注
  • 备注
  • └ address
  • String
  • 可选
  • 浙江省杭州市西湖区文二路398号
  • 详细地址, 格式: 浙江省杭州市西湖区文二路398号
  • └ wangwang_id
  • String
  • 可选
  • XXX店铺
  • 联系人旺旺
  • └ contact_name
  • String
  • 可选
  • 郭德纲
  • 联系人姓名
  • └ zip_code
  • String
  • 可选
  • 123000
  • 邮编
  • └ branch
  • String
  • 可选
  • 890
  • 分机号
  • └ telephone
  • String
  • 可选
  • 88602334
  • 座机号(电话或手机号必须填写1个)
  • └ area_id
  • Number
  • 可选
  • 330106
  • 地区ID(3级地址库ID) (建议传ID可以精确匹配到地址)
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • consign_goods
  • ConsignGoodsDto []
  • 必须
  • 发货的包裹
  • └ item_name
  • String
  • 必须
  • 衣服
  • 后台商品Name
  • └ remark
  • String
  • 可选
  • 备注
  • 备注
  • └ out_sub_trade_no
  • String
  • 必须
  • 123456
  • 子交易号
  • └ provider_id
  • Number
  • 可选
  • 123456
  • 后台商品货主Id
  • └ quantity
  • Number
  • 必须
  • 10
  • 商品数量
  • └ item_price
  • Number
  • 必须
  • 1000
  • 单位:分
  • └ item_id
  • String
  • 必须
  • 123456
  • 后台商品Id(若是仓配模式,则必填)
  • └ item_code
  • String
  • 可选
  • A-001
  • 后台商品编码
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • └ sku_id
  • Number
  • 可选
  • 123
  • 后端sku ID
  • consign_package_dto
  • ConsignPackageDto
  • 可选
  • 包裹信息
  • └ package_weight
  • String
  • 可选
  • 0.1
  • 包裹重量(克)
  • └ package_length
  • String
  • 可选
  • 0.1
  • 包裹长度(厘米)
  • └ package_height
  • String
  • 可选
  • 0.1
  • 包裹高度(厘米)
  • └ package_id
  • Number
  • 可选
  • 123456
  • 默认值:0
  • 包裹id(唯一)
  • └ package_volume
  • String
  • 可选
  • 0.1
  • 包裹体积(立方厘米)
  • └ package_width
  • String
  • 可选
  • 0.1
  • 包裹宽度(厘米)
  • └ is_sc_item
  • Boolean
  • 可选
  • false
  • 是否后端商品
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • tms_service_dto
  • TmsServiceDto
  • 可选
  • 普通配送
  • └ mail_no
  • String
  • 可选
  • 1106359157302
  • 运单号 若是自己联系物流,则必填 否则表示菜鸟自动获取运单号
  • └ cp_name
  • String
  • 可选
  • 中国邮政速递物流
  • 物流公司名称
  • └ cp_code
  • String
  • 可选
  • EMS
  • 物流公司 若为default 表示菜鸟路由物流公司 否则商家指定物流公司
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • └ seller_id
  • Number
  • 必须
  • 123456
  • 商家B2C商家用户ID 或者货主ID
  • tms_got_service_dto
  • TmsGotServiceDto
  • 可选
  • 配送公司上门揽收服务
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • got_address
  • ConsignContactDto
  • 可选
  • 揽收地址
  • └ contact_id
  • Number
  • 可选
  • 123456
  • 联系人地址唯一标识 (若传ID,则从商家地址库获取ID)
  • └ mobile_phone
  • String
  • 可选
  • 13322224444
  • 手机(电话或手机号必须填写1个)
  • └ ddd
  • String
  • 可选
  • 0571
  • 区号
  • └ remark
  • String
  • 可选
  • 备注
  • 备注
  • └ address
  • String
  • 可选
  • 浙江省杭州市西湖区文二路398号
  • 详细地址, 格式: 浙江省杭州市西湖区文二路398号
  • └ wangwang_id
  • String
  • 可选
  • XXX店铺
  • 联系人旺旺
  • └ contact_name
  • String
  • 可选
  • 郭德纲
  • 联系人姓名
  • └ zip_code
  • String
  • 可选
  • 123000
  • 邮编
  • └ branch
  • String
  • 可选
  • 890
  • 分机号
  • └ telephone
  • String
  • 可选
  • 88602334
  • 座机号(电话或手机号必须填写1个)
  • └ area_id
  • Number
  • 可选
  • 330106
  • 地区ID(3级地址库ID) (建议传ID可以精确匹配到地址)
  • └ extend_fields
  • Json
  • 可选
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
  • └ got_date
  • String
  • 可选
  • 20150501
  • 揽收日期yyyyMMdd
  • └ got_range
  • String
  • 可选
  • 09:00-10:00
  • 揽收时间段 09:00-10:00
  • └ logistics_solutions_code
  • String
  • 必须
  • WLB_KXZP
  • 物流服务解决方案Code,若选,表示以商家为准 否则菜鸟路由决定发货解决方案 举例:XJDCNP 小电菜鸟配 WLB_KXZP 快消宅配
  • └ order_source
  • Number
  • 必须
  • 1
  • 1:淘宝 2:聚划算 3:天猫 4:京东

响应参数

名称 类型 示例值 描述
out_trade_no String 123456 外部主订单号ID
extend_fields Json {"key1":"value1","key2":"value2"} 扩展字段 K:V;
consign_info_res_dtolist ConsignInfoResDto [] 菜鸟发货单号、仓内单据信息
  • └ mail_no
  • String
  • 1106359157302
  • 运单号
  • └ tms_code
  • String
  • TMS001
  • 配送公司代码
  • └ order_wms_code
  • String
  • LBX001
  • 仓储作业单号
  • └ store_code
  • String
  • WH001
  • 仓库代码
  • └ out_sub_trade_no_list
  • Json
  • {"123456":10,"12345678":20}
  • 拆单后包裹包括外部子订单号ID、数量 , 解决按照数量或子交易ID场景
  • └ order_consign_code
  • String
  • LP001
  • 菜鸟发货单号
  • └ extend_fields
  • Json
  • {"key1":"value1","key2":"value2"}
  • 扩展字段 K:V;
trace_id String 123456 单次调用唯一编号

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoOrderLogisticsConsignRequest req = new CainiaoOrderLogisticsConsignRequest();
ConsignTopRequestDto obj1 = new ConsignTopRequestDto();
obj1.setConfirmConsign(false);
obj1.setAppName("appkey123");
ConsignTopInfoDto obj2 = new ConsignTopInfoDto();
StoreServiceDto obj3 = new StoreServiceDto();
obj3.setStoreCode("WH001");
obj3.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj2.setStoreServiceDto(obj3);
ConsignContactDto obj4 = new ConsignContactDto();
obj4.setContactId(123456L);
obj4.setMobilePhone("13322224444");
obj4.setDdd("0571");
obj4.setRemark("备注");
obj4.setAddress("浙江省杭州市西湖区文二路398号");
obj4.setWangwangId("XXX店铺");
obj4.setContactName("郭德纲");
obj4.setZipCode("123000");
obj4.setBranch("890");
obj4.setTelephone("88602334");
obj4.setAreaId(330106L);
obj4.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj2.setReceiverContact(obj4);
obj2.setRemark("备注");
AppointServiceDto obj5 = new AppointServiceDto();
obj5.setOsDate("20150518");
obj5.setOsRange("09:00-18:00");
obj5.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj2.setAppointServiceDto(obj5);
ConsignContactDto obj6 = new ConsignContactDto();
obj6.setContactId(123456L);
obj6.setMobilePhone("13322224444");
obj6.setDdd("0571");
obj6.setRemark("备注");
obj6.setAddress("浙江省杭州市西湖区文二路398号");
obj6.setWangwangId("XXX店铺");
obj6.setContactName("郭德纲");
obj6.setZipCode("123000");
obj6.setBranch("890");
obj6.setTelephone("88602334");
obj6.setAreaId(330106L);
obj6.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj2.setSenderContact(obj6);
obj2.setOutTradeNo("123456");
obj2.setConsignType(0L);
InvoinceServiceDto obj7 = new InvoinceServiceDto();
obj7.setBillType(1L);
obj7.setBillTitle("XXX公司");
obj7.setBillAmount(100L);
obj7.setBillContent("发票内容");
obj7.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj2.setInvoinceServiceDto(obj7);
ConsignContactDto obj8 = new ConsignContactDto();
obj8.setContactId(123456L);
obj8.setMobilePhone("13322224444");
obj8.setDdd("0571");
obj8.setRemark("备注");
obj8.setAddress("浙江省杭州市西湖区文二路398号");
obj8.setWangwangId("XXX店铺");
obj8.setContactName("郭德纲");
obj8.setZipCode("123000");
obj8.setBranch("890");
obj8.setTelephone("88602334");
obj8.setAreaId(330106L);
obj8.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj2.setRefundContact(obj8);
List<ConsignGoodsDto> list10 = new ArrayList<ConsignGoodsDto>();
ConsignGoodsDto obj11 = new ConsignGoodsDto();
list10.add(obj11);
obj11.setItemName("衣服");
obj11.setRemark("备注");
obj11.setOutSubTradeNo("123456");
obj11.setProviderId(123456L);
obj11.setQuantity(10L);
obj11.setItemPrice(1000L);
obj11.setItemId("123456");
obj11.setItemCode("A-001");
obj11.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj11.setSkuId(123L);
ConsignPackageDto obj13 = new ConsignPackageDto();
obj13.setPackageWeight("0.1");
obj13.setPackageLength("0.1");
obj13.setPackageHeight("0.1");
obj13.setPackageId(123456L);
obj13.setPackageVolume("0.1");
obj13.setPackageWidth("0.1");
list12.setConsignPackageDto(obj13);
obj11.setIsScItem(false);
obj2.setConsignGoods(list10);
obj2.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
TmsServiceDto obj14 = new TmsServiceDto();
obj14.setMailNo("1106359157302");
obj14.setCpName("中国邮政速递物流");
obj14.setCpCode("EMS");
obj14.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj2.setTmsServiceDto(obj14);
obj2.setSellerId(123456L);
TmsGotServiceDto obj15 = new TmsGotServiceDto();
obj15.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
ConsignContactDto obj16 = new ConsignContactDto();
obj16.setContactId(123456L);
obj16.setMobilePhone("13322224444");
obj16.setDdd("0571");
obj16.setRemark("备注");
obj16.setAddress("浙江省杭州市西湖区文二路398号");
obj16.setWangwangId("XXX店铺");
obj16.setContactName("郭德纲");
obj16.setZipCode("123000");
obj16.setBranch("890");
obj16.setTelephone("88602334");
obj16.setAreaId(330106L);
obj16.setExtendFieldsString("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj15.setGotAddress(obj16);
obj15.setGotDate("20150501");
obj15.setGotRange("09:00-10:00");
obj2.setTmsGotServiceDto(obj15);
obj2.setLogisticsSolutionsCode("WLB_KXZP");
obj1.setConsignInfo(obj2);
obj1.setOrderSource(1L);
req.setConsignTopRequest(obj1);
CainiaoOrderLogisticsConsignResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_order_logistics_consign_response>
    <out_trade_no>123456</out_trade_no>
    <extend_fields>{&quot;key1&quot;:&quot;value1&quot;,&quot;key2&quot;:&quot;value2&quot;}</extend_fields>
    <consign_info_res_dtolist>
        <consign_info_res_dto>
            <mail_no>1106359157302</mail_no>
            <tms_code>TMS001</tms_code>
            <order_wms_code>LBX001</order_wms_code>
            <store_code>WH001</store_code>
            <out_sub_trade_no_list>{&quot;123456&quot;:10,&quot;12345678&quot;:20}</out_sub_trade_no_list>
            <order_consign_code>LP001</order_consign_code>
            <extend_fields>{&quot;key1&quot;:&quot;value1&quot;,&quot;key2&quot;:&quot;value2&quot;}</extend_fields>
        </consign_info_res_dto>
    </consign_info_res_dtolist>
    <trace_id>123456</trace_id>
</cainiao_order_logistics_consign_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.CD01 系统错误 请稍后重试
isv.CD02 参数为空 请检查必填参数
isv.CD03 没有订单ID 请检查out_trade_no是否正确
isv.CD04 没有权限进行发货 请申请权限
isv.CD05 订单状态为空 请检查订单状态
isv.CD06 推荐物流的订单状态为关闭状态,无需发货处理 无需发货处理
isv.CD07 物流订单状态不为新建状态,无需发货处理 无需发货处理
isv.CD08 无效的联系人 请检查发货人相关信息,如手机号码,电话等
isp.CD09 下发TMS失败 请重试
isp.CD10 TMS下发创建订单指令给CP失败 请重试
isp.CD11 系统错误,获取物流订单数据失败 请重试
isv.CD12 物流服务解决方案找不到 请检查是否传对
isv.CD13 根据详细地址解析区域ID失败 请检查的传入详细地址全面省市区街道地址
isv.CD14 判断配送商是否可达收货地址失败 请联系运营确定该区域是否有配置线路
isv.CD21 已拆单订单不能进行无需物流发货 请检查订单是否传入正确
isv.CD15 订单即是source订单又是parcel 订单!!! 请检查订单是否传入正确
isv.CD16 附属子商品不能找到主商品,不允许发货 请检查
isv.CD17 拆单校验未通过 请检查
isv.CD18 包裹信息为空 请检查
isv.CD19 不支持多包裹发货 请检查
isv.CD20 订单路由配送公司时线路为空 请检查线路
isv.CD22 订单空校验,全量订单的订单为null 请检查
isv.CD23 订单空校验,全量订单的订单商品列表为null 请检查
isv.CD24 订单空校验,全量订单的订单商品列表为空 请检查
isv.CD25 订单空校验,全量订单收货地址为空 请检查
isv.CD26 订单空校验,全量订单收货地址省份为空 请检查
isv.CD27 订单空校验,全量订单收货地址城市为空 请检查
isv.CD28 收货人市信息不能为空 请检查
isv.CD29 收件人信息不能为空 请检查
isv.CD30 收货人地址信息不能为空 请检查
isv.CD31 取货收货人区域id不能非法 请检查
isv.CD32 收件人姓名信息不能为空 请检查
isv.CD33 收件人联系手机和座机不能同时为空 请检查
isv.CD34 收货人市下面有区县但是没有传区县 请检查
isv.CD35 收货人信息校验发生异常 请检查
isv.CD36 查询省份城市对象入参为空 请检查
isv.CD37 城市下面找不到区县信息 请检查
isv.CD38 城市下面找不到收货区县信息 请检查
isv.CD39 收款人地区检验异常 请检查
isv.CD44 查询省份城市入参为空 请检查
isv.CD45 查询省份省份对象入参为空 请检查
isv.CD46 省份下面找不到任何地级市信息 请检查
isv.CD47 收件地址下面找不到地级市信息 请检查
isv.CD48 收件人联系方式修改检查发生异常 请检查
isv.CD49 收件人省份地址不正确 请检查
isv.CD50 收款人省份校验异常 请检查
isv.CD51 发货人地址信息为空 请检查
isv.CD52 发货人姓名信息不能为空 请检查
isv.CD53 发货人areaId不能为空 请检查
isv.CD54 发货人AreaId(区域ID)非法 请检查
isv.CD55 发货人市信息不能为空 请检查
isv.CD56 市下面有区县信息但是没有传区县 请检查
isv.CD57 发货人详细地址信息不能为空 请检查
isv.CD58 校验发货人地址信息发生异常 请检查
isv.CD59 地址库区域为空 请检查
isv.CD60 详细地址非法 请检查
isv.CD61 手机号非法 请检查
isv.CD62 电话号码非法 请检查
isv.CD63 邮编非法 请检查
isv.CD64 联系人校验发生异常 请检查
isv.CD65 查询用户订购服务商品结果为空 请检查商家是否订购了对应的服务商品
isp.CD66 查询用户订购服务商品,发生错误 请稍后重试
isp.CD67 查询用户订购服务商品,发生异常 请稍后重试

API工具

如何获得此API

FAQ

返回
顶部