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

cainiao.guoguo.fulfil.query.goodtypelist (快递员开箱验视服务queryGoodTypeList)

queryGoodTypeList

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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的版本号
execute_user_list ExecuteUserDto [] 必须
  • 最大列表长度:20
  • 账号list
    • └ execute_user_id
    • Number
    • 必须
    • 0
    • 参数executeUserId
    • └ execute_user_type
    • String
    • 必须
    • foo
    • 参数executeUserType
    personal_session String 必须 dsdf324234234324 个人账号sessionCode不能为空
    personal_user_id Number 必须 324234234324 个人账号ID不能为空
    task_order_id Number 必须 1042423423 履行任务单ID不能为空

    响应参数

    名称 类型 示例值 描述
    data GoodTypeResDto 参数data
    • good_type_list
    • GoodTypeInfo []
    • 参数goodTypeList
    • └ id
    • Number
    • 0
    • 参数id
    • └ name
    • String
    • foo
    • 参数name
    status_code String PARAMS_CANNOT_BE_NULL 错误码
    status_message String 参数不能为空 错误描述
    is_success Boolean true 是否成功
    trace_id String 0be4314615320739620257888e18e2 鹰眼ID

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGuoguoFulfilQueryGoodtypelistRequest req = new CainiaoGuoguoFulfilQueryGoodtypelistRequest();
    CainiaoGuoguoFulfilQueryGoodtypelistRequest.AppContextParam obj1 = new CainiaoGuoguoFulfilQueryGoodtypelistRequest.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);
    List<CainiaoGuoguoFulfilQueryGoodtypelistRequest.ExecuteUserDto> list3 = new ArrayList<CainiaoGuoguoFulfilQueryGoodtypelistRequest.ExecuteUserDto>();
    CainiaoGuoguoFulfilQueryGoodtypelistRequest.ExecuteUserDto obj4 = new CainiaoGuoguoFulfilQueryGoodtypelistRequest.ExecuteUserDto();
    list3.add(obj4);
    obj4.setExecuteUserId(0L);
    obj4.setExecuteUserType("foo");
    req.setExecuteUserList(list3);
    req.setPersonalSession("dsdf324234234324");
    req.setPersonalUserId(324234234324L);
    req.setTaskOrderId(1042423423L);
    CainiaoGuoguoFulfilQueryGoodtypelistResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_guoguo_fulfil_query_goodtypelist_response>
        <data>
            <good_type_list>
                <good_type_info>
                    <id>0</id>
                    <name>foo</name>
                </good_type_info>
            </good_type_list>
        </data>
        <status_code>PARAMS_CANNOT_BE_NULL</status_code>
        <status_message>参数不能为空</status_message>
        <is_success>true</is_success>
        <trace_id>0be4314615320739620257888e18e2</trace_id>
    </cainiao_guoguo_fulfil_query_goodtypelist_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

    返回
    顶部