文档中心 > API类目 > 菜鸟无线API

cainiao.guoguo.fulfil.updateaddress (快递员修改收寄件人地址)

updateAddressByCourier

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
address String 可选 杭州 寄件/收件人地址
app_context_param AppContextParam 可选 客户端信息
  • └ app_battery
  • String
  • 可选
  • 45
  • 电池用电量
  • └ device_type
  • String
  • 可选
  • ios
  • app是android还是ios
  • └ loc_accuracy
  • String
  • 可选
  • 23
  • 小件员-定位时间
  • └ loc_auth
  • String
  • 可选
  • true
  • gps-定位权限授予
  • └ loc_lat
  • String
  • 可选
  • 123.22
  • 小件员-所在的纬度
  • └ loc_lng
  • String
  • 可选
  • 123.22
  • 小件员-所在的经度
  • └ loc_open
  • String
  • 可选
  • true
  • gps-定位是否打开,GPS定位开启
  • └ loc_succ
  • String
  • 可选
  • true
  • gps-定位是否成功
  • └ loc_time
  • Number
  • 可选
  • 123
  • 小件员-定位时间
  • └ loc_type
  • String
  • 可选
  • gps
  • 小件员-定位方式
  • └ pkg_id
  • String
  • 可选
  • fsdfId
  • 对应包裹侠的包id
  • └ pkg_name
  • String
  • 可选
  • fsdf.sdf
  • 对应包裹侠的包名
  • └ sdk_version
  • String
  • 可选
  • 6.0.1
  • sdk的版本号
area_id String 可选 1346 修改寄件人/收件人运营区id
area_name String 可选 五常 修改寄件人/收件人地区名称
city_name String 可选 杭州市 修改寄件人/收件人市名称
execute_user_list ExecuteUserDto [] 可选
  • 最大列表长度:20
  • 账号list
    • └ execute_user_id
    • Number
    • 可选
    • 0
    • 参数executeUserId
    • └ execute_user_type
    • String
    • 可选
    • foo
    • 参数executeUserType
    name String 可选 张三 寄件/收件人名称
    personal_session String 可选 dsdf324234234324 个人账号sessionCode不能为空
    personal_user_id Number 可选 324234234324 个人账号ID不能为空
    phone String 可选 1891 寄件/收件人电话
    prov_name String 可选 浙江省 修改寄件人/收件人省名称
    street_name String 可选 五常街道 修改寄件人/收件人街道名称
    task_order_id Number 可选 1042423423 履行任务单ID不能为空
    type Number 可选 1 修改寄件人/收件人类型
    dpatch_env String 可选 1 环境参数

    响应参数

    名称 类型 示例值 描述
    data UpdateAddressResDto false 参数data
    • └ pay_state
    • Number
    • 1
    • 支付状态
    • └ is_check_bill
    • Boolean
    • true
    • 是否已经核价
    • └ is_open_order_bill
    • Boolean
    • true
    • 是否可以核价
    • └ update_ret
    • Boolean
    • true
    • 修改地址的结果
    • └ task_status
    • String
    • 20
    • 任务状态
    status_code String PARAMS_CANNOT_BE_NULL 错误码
    status_message String 参数不能为空 错误描述
    is_success Boolean true 是否成功
    trace_id String 3423423423 鹰眼id

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGuoguoFulfilUpdateaddressRequest req = new CainiaoGuoguoFulfilUpdateaddressRequest();
    req.setAddress("杭州");
    CainiaoGuoguoFulfilUpdateaddressRequest.AppContextParam obj1 = new CainiaoGuoguoFulfilUpdateaddressRequest.AppContextParam();
    obj1.setAppBattery("45");
    obj1.setDeviceType("ios");
    obj1.setLocAccuracy("23");
    obj1.setLocAuth("true");
    obj1.setLocLat("123.22");
    obj1.setLocLng("123.22");
    obj1.setLocOpen("true");
    obj1.setLocSucc("true");
    obj1.setLocTime(123L);
    obj1.setLocType("gps");
    obj1.setPkgId("fsdfId");
    obj1.setPkgName("fsdf.sdf");
    obj1.setSdkVersion("6.0.1");
    req.setAppContextParam(obj1);
    req.setAreaId("1346");
    req.setAreaName("五常");
    req.setCityName("杭州市");
    List<CainiaoGuoguoFulfilUpdateaddressRequest.ExecuteUserDto> list3 = new ArrayList<CainiaoGuoguoFulfilUpdateaddressRequest.ExecuteUserDto>();
    CainiaoGuoguoFulfilUpdateaddressRequest.ExecuteUserDto obj4 = new CainiaoGuoguoFulfilUpdateaddressRequest.ExecuteUserDto();
    list3.add(obj4);
    obj4.setExecuteUserId(0L);
    obj4.setExecuteUserType("foo");
    req.setExecuteUserList(list3);
    req.setName("张三");
    req.setPersonalSession("dsdf324234234324");
    req.setPersonalUserId(324234234324L);
    req.setPhone("1891");
    req.setProvName("浙江省");
    req.setStreetName("五常街道");
    req.setTaskOrderId(1042423423L);
    req.setType(1L);
    req.setDpatchEnv("1");
    CainiaoGuoguoFulfilUpdateaddressResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_guoguo_fulfil_updateaddress_response>
        <data>
            <pay_state>1</pay_state>
            <is_check_bill>true</is_check_bill>
            <is_open_order_bill>true</is_open_order_bill>
            <update_ret>true</update_ret>
            <task_status>20</task_status>
        </data>
        <status_code>PARAMS_CANNOT_BE_NULL</status_code>
        <status_message>参数不能为空</status_message>
        <is_success>true</is_success>
        <trace_id>3423423423</trace_id>
    </cainiao_guoguo_fulfil_updateaddress_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

    返回
    顶部