文档中心 > API类目 > 全球速卖通-物流管理

cainiao.global.handover.commit (提交发布交接单)

提供给ISV通过该接口提交发布交接单

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
remark String 可选 易碎 大包备注
return_info ReturnerDto 可选 退件信息
  • address
  • AddressDto
  • 可选
  • 退件地址
  • └ zip_code
  • String
  • 可选
  • 310012
  • 邮编
  • └ detail_address
  • String
  • 必须
  • 文一西路680菜鸟
  • 详细地址
  • └ street
  • String
  • 必须
  • 蒋村街道
  • 街道
  • └ district
  • String
  • 必须
  • 西湖区
  • └ city
  • String
  • 必须
  • 杭州市
  • └ province
  • String
  • 必须
  • 浙江省
  • └ country
  • String
  • 必须
  • 中国
  • 国家
  • └ email
  • String
  • 可选
  • alibaba@alibaba-inc.com
  • 邮箱
  • └ mobile
  • String
  • 可选
  • 1760x000007
  • 移动电话, 校验格式:^1(3|4|5|6|7|8|9)\d{9}$
  • └ phone
  • String
  • 可选
  • 098-234234
  • 固定电话,可空,校验格式:(^0[\d]{2,3}-[\d]{7,8}$)|(^400[\d]{3,4}[\d]{3,4}$)|(400-[\d]{3,4}-[\d]{3,4}$)
  • └ name
  • String
  • 可选
  • 张三
  • 退件联系人名称,必须包含中文字符
  • └ address_id
  • Number
  • 可选
  • 3455657
  • AE后台维护的退件地址ID
pickup_info PickupDto 必须 揽收信息
  • address
  • AddressDto
  • 可选
  • 揽收地址
  • └ zip_code
  • String
  • 可选
  • 310012
  • 邮编
  • └ detail_address
  • String
  • 必须
  • 文一西路680菜鸟
  • 详细地址
  • └ street
  • String
  • 必须
  • 蒋村街道
  • 街道
  • └ district
  • String
  • 必须
  • 西湖区
  • └ city
  • String
  • 必须
  • 杭州市
  • └ province
  • String
  • 必须
  • 浙江省
  • └ country
  • String
  • 必须
  • 中国
  • 国家
  • └ email
  • String
  • 可选
  • alibaba@alibaba-inc.com
  • 邮箱
  • └ mobile
  • String
  • 可选
  • 1760x000007
  • 移动电话, 校验格式:^1(3|4|5|6|7|8|9)\d{9}$
  • └ phone
  • String
  • 可选
  • 098-234234
  • 固定电话,可空,校验格式:(^0[\d]{2,3}-[\d]{7,8}$)|(^400[\d]{3,4}[\d]{3,4}$)|(400-[\d]{3,4}-[\d]{3,4}$)
  • └ name
  • String
  • 可选
  • 张三
  • 揽收联系人名称,必须包含中文字符
  • └ address_id
  • Number
  • 可选
  • 124345
  • AE后台维护的发件地址ID
order_code_list String [] 必须 LP0001,LP0002
  • 最大列表长度:1000
  • 要创建交接单的小包编码集合,数量上限1000
    weight Number 可选 1000 大包重量
    handover_order_id Number 可选 100001 交接单id
    user_info UserInfoDto 必须 用户信息
    • └ top_user_key
    • String
    • 可选
    • 123
    • 每个商家在ISV系统的唯一标识,一般为商家ISV账号的id
    weight_unit String 可选 kg
  • 默认值:g
  • 重量单位,克:g, 千克:kg,默认g
    type String 可选 self_post
  • 默认值:cainiao_pickup
  • 交接单类型:cainiao_pickup(菜鸟揽收)、self_post(自寄)、self_send(自送)
    client String 必须 ISVA ISV名称,ISV:ISV-ISV英文或拼音名称、商家ERP:SELLER-商家英文或拼音名称
    locale String 可选 zh_CN 多语言
    features Features 可选 扩展字段
    • └ gmt_ready_to_ship
    • Number
    • 可选
    • 10010101000
    • 货好时间时间戳
    • └ pallet_quantity
    • Number
    • 可选
    • 12
    • 托盘数量
    • └ container_type
    • String
    • 可选
    • 1
    • 容器类型(1、托盘;2、大包或盒子3、散装)
    • └ pre_package
    • String
    • 可选
    • true
    • 是否预先组大包,true:是。false:否
    appointment_type String 可选 bigbag
  • 默认值:bigbag
  • 预约交货方式(bigbag:大包预约,batch:批次预约))
    domestic_tracking_no String 可选 SF22324322 国内运单号(交接单类型type为self_post(自寄)时必填)
    domestic_logistics_company_id Number 可选 505 国内物流公司id(交接单类型type为self_post(自寄)时必填)
    domestic_logistics_company String 可选 顺丰速运 国内物流公司名称(交接单类型type为self_post(自寄)时必填)

    响应参数

    名称 类型 示例值 描述
    result HsfResult 请求结果
    • data
    • OpenHandoverCommitResponse
    • 响应数据
    • └ handover_content_id
    • Number
    • 100002
    • 交接物id,即大包id
    • └ handover_order_id
    • Number
    • 20000002
    • 交接批次号,即交接单id
    • └ handover_content_code
    • String
    • LP00002
    • 交接物编码,即大包LP号
    • └ error_msg
    • String
    • 系统异常
    • 错误信息
    • └ error_code
    • String
    • P-088-0000-00-99-000
    • 异常码
    • └ success
    • Boolean
    • true
    • 请求处理是否成功

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGlobalHandoverCommitRequest req = new CainiaoGlobalHandoverCommitRequest();
    req.setRemark("易碎");
    CainiaoGlobalHandoverCommitRequest.ReturnerDto obj1 = new CainiaoGlobalHandoverCommitRequest.ReturnerDto();
    CainiaoGlobalHandoverCommitRequest.AddressDto obj2 = new CainiaoGlobalHandoverCommitRequest.AddressDto();
    obj2.setZipCode("310012");
    obj2.setDetailAddress("文一西路680菜鸟");
    obj2.setStreet("蒋村街道");
    obj2.setDistrict("西湖区");
    obj2.setCity("杭州市");
    obj2.setProvince("浙江省");
    obj2.setCountry("中国");
    obj1.setAddress(obj2);
    obj1.setEmail("alibaba@alibaba-inc.com");
    obj1.setMobile("1760x000007");
    obj1.setPhone("098-234234");
    obj1.setName("张三");
    obj1.setAddressId(3455657L);
    req.setReturnInfo(obj1);
    CainiaoGlobalHandoverCommitRequest.PickupDto obj3 = new CainiaoGlobalHandoverCommitRequest.PickupDto();
    CainiaoGlobalHandoverCommitRequest.AddressDto obj4 = new CainiaoGlobalHandoverCommitRequest.AddressDto();
    obj4.setZipCode("310012");
    obj4.setDetailAddress("文一西路680菜鸟");
    obj4.setStreet("蒋村街道");
    obj4.setDistrict("西湖区");
    obj4.setCity("杭州市");
    obj4.setProvince("浙江省");
    obj4.setCountry("中国");
    obj3.setAddress(obj4);
    obj3.setEmail("alibaba@alibaba-inc.com");
    obj3.setMobile("1760x000007");
    obj3.setPhone("098-234234");
    obj3.setName("张三");
    obj3.setAddressId(124345L);
    req.setPickupInfo(obj3);
    req.setOrderCodeList("LP0001,LP0002");
    req.setWeight(1000L);
    req.setHandoverOrderId(100001L);
    CainiaoGlobalHandoverCommitRequest.UserInfoDto obj5 = new CainiaoGlobalHandoverCommitRequest.UserInfoDto();
    obj5.setTopUserKey("123");
    req.setUserInfo(obj5);
    req.setWeightUnit("kg");
    req.setType("self_post");
    req.setClient("ISVA");
    req.setLocale("zh_CN");
    CainiaoGlobalHandoverCommitRequest.Features obj6 = new CainiaoGlobalHandoverCommitRequest.Features();
    obj6.setGmtReadyToShip(10010101000L);
    obj6.setPalletQuantity(12L);
    obj6.setContainerType("1");
    obj6.setPrePackage("true");
    req.setFeatures(obj6);
    req.setAppointmentType("bigbag");
    req.setDomesticTrackingNo("SF22324322");
    req.setDomesticLogisticsCompanyId(505L);
    req.setDomesticLogisticsCompany("顺丰速运");
    CainiaoGlobalHandoverCommitResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_global_handover_commit_response>
        <result>
            <data>
                <handover_content_id>100002</handover_content_id>
                <handover_order_id>20000002</handover_order_id>
                <handover_content_code>LP00002</handover_content_code>
            </data>
            <error_msg>系统异常</error_msg>
            <error_code>P-088-0000-00-99-000</error_code>
            <success>true</success>
        </result>
    </cainiao_global_handover_commit_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>

    错误码解释

    错误码 错误描述 解决方案
    P-088-0000-00-15-015 参数里的部分小包不能组包 确保小包状态是等待组包交接状态
    P-088-0101-10-10-043 地址解析错误 请确保省市区街道都是正确的中文
    P-088-0101-10-10-101 未找到对应的大包 请确认入参是否正确
    P-088-0000-00-15-010 揽收联系人手机号码错误 检查手机号码确认无误后重试
    P-088-0000-00-15-009 揽收联系人座机号码错误 检查座机号码确认无误后重试
    P-088-0101-10-10-080 已经组包的小包不能重复组包 删除已经组包的小包后重试
    P-088-0000-00-15-019 揽收地址中的详细地址必须包含中文 修改揽收联系人的详细地址后重试
    P-088-0101-10-10-158 揽收联系人的省或市不能为空 补充完整省和市信息后重试
    P-088-0101-10-10-115 非待组包交接状态的小包不能组包 删除非待组包交接状态的小包后重试
    P-088-0101-10-10-014 未找到对应的大包 请确认入参是否正确
    P-088-0101-10-10-096 只有草稿状态的大包才能提交发布 使用草稿状态的大包提交发布
    P-088-0101-10-10-140 参数里的所有小包都找不到 确保小包状态是等待组包交接
    P-088-0101-10-10-143 您的地址不在选择的仓库的揽收范围内 修改小包的揽收仓后重试
    P-088-0101-10-10-152 地址解析错误 确保省市区街道都是正确的中文
    P-088-0000-00-99-001 网络异常,请稍后重试 请稍后重试
    P-088-0101-10-10-013 选择的小包的交接仓库不一致 请确保小包的目的仓库相同
    P-088-0000-00-15-045 参数不能为空 补充参数后重试
    P-088-0101-10-10-150 地址解析出错 请稍后重试
    P-088-0101-10-10-151 地址解析出错 请稍后重试
    P-088-0101-10-10-153 地址解析出错 请稍后重试
    P-088-0101-10-10-154 地址解析出错 请稍后重试
    P-088-0101-10-10-155 地址解析出错 请稍后重试
    P-088-0101-10-10-157 地址解析出错 请稍后重试
    P-088-0101-10-10-168 跨店铺授权出错 请稍后重试
    P-088-0000-00-15-004 重量单位不支持 换成g之后重试
    P-088-0000-00-15-048 参数中未选择任何小包 选择小包后重试
    P-088-0000-00-15-049 选择的要组包的小包数量超过最大限制200 删除部分小包后重试
    P-088-0000-00-15-008 未填写手机号 填写正确的手机号后重试
    P-088-0000-00-15-011 没有填写揽收地址信息 填写揽收地址信息后重试
    P-088-0101-10-10-116 未选择任何小包 选择要组包的小包后重试
    P-088-0101-10-10-026 选择的小包超过重量上限30kg 删除部分小包后重试
    P-088-0101-10-10-021 创建大包失败 联系客服
    P-088-0101-10-10-032 找不到对应的报价 联系客服

    API工具

    如何获得此API

    FAQ

    返回
    顶部