文档中心 > API类目 > 菜鸟裹裹API

cainiao.yima.business.data (通用数据接口:离职状态、透传数据等)

小件员登陆时业务相关信息接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 可选 4398046856801 小件员id
session_code String 可选 asdasdasd 小件员session

响应参数

名称 类型 示例值 描述
data UserResignDto data
  • user_info
  • UserInfo
  • userInfo
  • └ resign_status
  • Number
  • 2
  • 离职状态,0-未离职,1-离职中,2-已离职
  • └ resign_time
  • String
  • 08:00-10:00
  • 离职时间
  • └ extend_data
  • String
  • { "is_signed": true, }
  • 动态拓展字段,有具体服务产生,Json格式的String
  • └ config_data
  • String
  • {"wallet-tile":"我的钱包","wallet-menu":[{"name":"余额","url":"http://www.cainiao.com"}]}
  • 静态拓展字段,Diamond配置字段,Json格式的String
status_code String 2 错误码
status_message String a s da s d 错误信息
is_success Boolean false 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaBusinessDataRequest req = new CainiaoYimaBusinessDataRequest();
req.setUserId(4398046856801L);
req.setSessionCode("asdasdasd");
CainiaoYimaBusinessDataResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_business_data_response>
    <data>
        <user_info>
            <resign_status>2</resign_status>
            <resign_time>08:00-10:00</resign_time>
        </user_info>
        <extend_data>{     &quot;is_signed&quot;: true, }</extend_data>
        <config_data>{&quot;wallet-tile&quot;:&quot;我的钱包&quot;,&quot;wallet-menu&quot;:[{&quot;name&quot;:&quot;余额&quot;,&quot;url&quot;:&quot;http://www.cainiao.com&quot;}]}</config_data>
    </data>
    <status_code>2</status_code>
    <status_message>a s da s d</status_message>
    <is_success>false</is_success>
</cainiao_yima_business_data_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

返回
顶部