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

cainiao.global.handover.update (修改交接单)

提供给ISV通过该接口修改交接单

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_info UserInfoDto 必须 用户信息
  • └ top_user_key
  • String
  • 可选
  • 123
  • 每个商家在ISV系统的唯一标识,一般为商家ISV账号的id
weight_unit String 可选 kg
  • 默认值:g
  • 重量单位,克:g, 千克:kg,默认g
    weight Number 可选 1000 大包重量
    handover_order_id Number 必须 10001 交接单id
    remark String 可选 易碎品 大包备注
    return_info ReturnerDto 可选 退件信息
    • address
    • AddressDto
    • 可选
    • 退件地址
    • └ zip_code
    • String
    • 可选
    • 100
    • 邮编
    • └ 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
    • 可选
    • 124533
    • AE后台维护的退件地址ID
    pickup_info PickupDto 可选 揽收信息
    • address
    • AddressDto
    • 可选
    • 揽收地址
    • └ zip_code
    • String
    • 可选
    • 100
    • 邮编
    • └ 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
    • 可选
    • 342535
    • AE后台维护的发件地址ID
    type String 可选 self_post
  • 默认值:cainiao_pickup
  • 交接单类型,菜鸟揽收(cainiao_pickup)或自寄(self_post),默认菜鸟揽收
    client String 必须 ISV-A ISV名称,ISV:ISV-ISV英文或拼音名称、商家ERP:SELLER-商家英文或拼音名称
    order_code_list String [] 必须 LP0001, LP0002
  • 最大列表长度:200
  • 要创建交接单的小包编码集合,数量上限200
    locale String 可选 zh_CN 多语言

    响应参数

    名称 类型 示例值 描述
    result HsfResult 请求结果
    • data
    • OpenHandoverUpdateResponse
    • 响应数据
    • └ result
    • Boolean
    • true
    • 更新结果
    • └ 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);
    CainiaoGlobalHandoverUpdateRequest req = new CainiaoGlobalHandoverUpdateRequest();
    CainiaoGlobalHandoverUpdateRequest.UserInfoDto obj1 = new CainiaoGlobalHandoverUpdateRequest.UserInfoDto();
    obj1.setTopUserKey("123");
    req.setUserInfo(obj1);
    req.setWeightUnit("kg");
    req.setWeight(1000L);
    req.setHandoverOrderId(10001L);
    req.setRemark("易碎品");
    CainiaoGlobalHandoverUpdateRequest.ReturnerDto obj2 = new CainiaoGlobalHandoverUpdateRequest.ReturnerDto();
    CainiaoGlobalHandoverUpdateRequest.AddressDto obj3 = new CainiaoGlobalHandoverUpdateRequest.AddressDto();
    obj3.setZipCode("100");
    obj3.setDetailAddress("文一西路680菜鸟");
    obj3.setStreet("蒋村街道");
    obj3.setDistrict("西湖区");
    obj3.setCity("杭州市");
    obj3.setProvince("浙江省");
    obj3.setCountry("中国");
    obj2.setAddress(obj3);
    obj2.setEmail("alibaba@alibaba-inc.com");
    obj2.setMobile("1760x000007");
    obj2.setPhone("098-234234");
    obj2.setName("张三");
    obj2.setAddressId(124533L);
    req.setReturnInfo(obj2);
    CainiaoGlobalHandoverUpdateRequest.PickupDto obj4 = new CainiaoGlobalHandoverUpdateRequest.PickupDto();
    CainiaoGlobalHandoverUpdateRequest.AddressDto obj5 = new CainiaoGlobalHandoverUpdateRequest.AddressDto();
    obj5.setZipCode("100");
    obj5.setDetailAddress("文一西路680菜鸟");
    obj5.setStreet("蒋村街道");
    obj5.setDistrict("西湖区");
    obj5.setCity("杭州市");
    obj5.setProvince("浙江省");
    obj5.setCountry("中国");
    obj4.setAddress(obj5);
    obj4.setEmail("alibaba@alibaba-inc.com");
    obj4.setMobile("1760x000007");
    obj4.setPhone("098-234234");
    obj4.setName("张三");
    obj4.setAddressId(342535L);
    req.setPickupInfo(obj4);
    req.setType("self_post");
    req.setClient("ISV-A");
    req.setOrderCodeList("LP0001, LP0002");
    req.setLocale("zh_CN");
    CainiaoGlobalHandoverUpdateResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_global_handover_update_response>
        <result>
            <data>
                <result>true</result>
            </data>
            <error_msg>系统异常</error_msg>
            <error_code>P-088-0000-00-99-000</error_code>
            <success>true</success>
        </result>
    </cainiao_global_handover_update_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

    返回
    顶部