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

cainiao.global.handover.savedraft (创建交接单草稿)

提供给ISV通过该接口创建交接单草稿

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_info UserInfoDto 必须 用户信息
  • └ top_user_key
  • String
  • 可选
  • 123
  • 每个商家在ISV系统的唯一标识,一般为商家ISV账号的id
remark String 可选 xxx 备注
weight Number 可选 1000 大包重量
weight_unit String 可选 kg
  • 默认值:g
  • 重量单位,克:g, 千克:kg,默认g
    pickup_info PickupDto 必须 揽收信息
    • └ name
    • String
    • 可选
    • 张三
    • 揽收联系人名称,必须包含中文字符
    • └ 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}$)
    • └ mobile
    • String
    • 可选
    • 1762xxx0987
    • 移动电话, 校验格式:^1(3|4|5|6|7|8|9)\d{9}$
    • └ email
    • String
    • 可选
    • alibaba@alibaba-inc.com
    • 邮箱
    • address
    • AddressDto
    • 可选
    • 揽收地址
    • └ country
    • String
    • 必须
    • 中国
    • 国家
    • └ province
    • String
    • 必须
    • 浙江省
    • └ city
    • String
    • 必须
    • 杭州市
    • └ district
    • String
    • 必须
    • 西湖区
    • └ street
    • String
    • 必须
    • 蒋村街道
    • 街道
    • └ detail_address
    • String
    • 必须
    • 文一西路680菜鸟
    • 详细地址
    • └ zip_code
    • String
    • 可选
    • 310012
    • 邮编
    • └ address_id
    • Number
    • 可选
    • 123353
    • AE后台维护的发件地址ID
    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
    • 必须
    • 17620150987
    • 移动电话, 校验格式:^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
    • 可选
    • 233453
    • AE后台维护的退货地址ID
    client String 必须 ISVA 客户端名称,ISV:ISV-ISV英文或拼音名称、商家ERP:SELLER-商家英文或拼音名称
    order_code_list String [] 必须 LP001,LP002
  • 最大列表长度:200
  • 需要组装大包的小包编码集合,最多限制200个小包
    locale String 可选 zh_CN 多语言

    响应参数

    名称 类型 示例值 描述
    result HsfResult 请求结果
    • data
    • OpenHandoverDraftSaveResponse
    • 响应数据
    • └ handover_order_id
    • Number
    • 10000001
    • 交接批次号,即交接单id
    • └ handover_content_id
    • Number
    • 200001
    • 交接物id,即大包id
    • └ 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);
    CainiaoGlobalHandoverSavedraftRequest req = new CainiaoGlobalHandoverSavedraftRequest();
    CainiaoGlobalHandoverSavedraftRequest.UserInfoDto obj1 = new CainiaoGlobalHandoverSavedraftRequest.UserInfoDto();
    obj1.setTopUserKey("123");
    req.setUserInfo(obj1);
    req.setRemark("xxx");
    req.setWeight(1000L);
    req.setWeightUnit("kg");
    CainiaoGlobalHandoverSavedraftRequest.PickupDto obj2 = new CainiaoGlobalHandoverSavedraftRequest.PickupDto();
    obj2.setName("张三");
    obj2.setPhone("098-234234");
    obj2.setMobile("1762xxx0987");
    obj2.setEmail("alibaba@alibaba-inc.com");
    CainiaoGlobalHandoverSavedraftRequest.AddressDto obj3 = new CainiaoGlobalHandoverSavedraftRequest.AddressDto();
    obj3.setCountry("中国");
    obj3.setProvince("浙江省");
    obj3.setCity("杭州市");
    obj3.setDistrict("西湖区");
    obj3.setStreet("蒋村街道");
    obj3.setDetailAddress("文一西路680菜鸟");
    obj3.setZipCode("310012");
    obj2.setAddress(obj3);
    obj2.setAddressId(123353L);
    req.setPickupInfo(obj2);
    CainiaoGlobalHandoverSavedraftRequest.ReturnerDto obj4 = new CainiaoGlobalHandoverSavedraftRequest.ReturnerDto();
    CainiaoGlobalHandoverSavedraftRequest.AddressDto obj5 = new CainiaoGlobalHandoverSavedraftRequest.AddressDto();
    obj5.setZipCode("310012");
    obj5.setDetailAddress("文一西路680菜鸟");
    obj5.setStreet("蒋村街道");
    obj5.setDistrict("西湖区");
    obj5.setCity("杭州市");
    obj5.setProvince("浙江省");
    obj5.setCountry("中国");
    obj4.setAddress(obj5);
    obj4.setEmail("alibaba@alibaba-inc.com");
    obj4.setMobile("17620150987");
    obj4.setPhone("098-234234");
    obj4.setName("张三");
    obj4.setAddressId(233453L);
    req.setReturnInfo(obj4);
    req.setClient("ISVA");
    req.setOrderCodeList("LP001,LP002");
    req.setLocale("zh_CN");
    CainiaoGlobalHandoverSavedraftResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_global_handover_savedraft_response>
        <result>
            <data>
                <handover_order_id>10000001</handover_order_id>
                <handover_content_id>200001</handover_content_id>
            </data>
            <error_msg>系统异常</error_msg>
            <error_code>P-088-0000-00-99-000</error_code>
            <success>true</success>
        </result>
    </cainiao_global_handover_savedraft_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-0000-00-15-007 没有设置揽收联系人信息 设置揽收联系人信息后重试
    P-088-0000-00-15-009 揽收联系人座机号码错误 检查座机号码确认无误后重试
    P-088-0101-10-10-140 参数里的所有小包都找不到 确保小包状态是等待组包交接
    P-088-0000-00-15-009 揽收联系人座机号码错误 检查座机号码确认无误后重试
    P-088-0101-10-10-140 参数里的所有小包都找不到 确保小包状态是等待组包交接

    API工具

    如何获得此API

    FAQ

    返回
    顶部