文档中心 > API类目 > 驿马前台api

cainiao.yima.urlroute.getlist (查询多CP的URLRoute配置)

支持同时查询多个CP的URLRoute配置

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 必须 1234 菜鸟用户ID
session_code String 必须 23131 sessionCode
cp_codes String 必须 K_TTKD,K_YTO 要查询配置的CPCodes
route_versions String 必须 {"K_TTKD":"6", "K_YTO":"1"} 对应的路由版本
user_agent String 必须 {"OSVersion":"5.0.2","appName":"天宝","appVersion":"1.4.9.2","clientType":"android","deviceModel":"Redmi Note 2","deviceName":"Xiaomi","packageName":"com.kaicom.ttk","sdkVersion":"3.4.0"} userAgent

响应参数

名称 类型 示例值 描述
status_code String 2 statusCode
data UrlRoute4MultiCPsDto data data
  • └ content
  • String
  • {"xxxkey1":"xxxValue1","xxxkey2":"xxxValue2"}
  • content
  • └ route_version_map
  • String
  • {"K_TTKD":"7", "K_YTO":"13"}
  • routeVersionMap
is_success Boolean true isSuccess
status_message String 调用成功 statusMessage

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaUrlrouteGetlistRequest req = new CainiaoYimaUrlrouteGetlistRequest();
req.setUserId(1234L);
req.setSessionCode("23131");
req.setCpCodes("K_TTKD,K_YTO");
req.setRouteVersions("{\"K_TTKD\":\"6\", \"K_YTO\":\"1\"}");
req.setUserAgent("{\"OSVersion\":\"5.0.2\",\"appName\":\"天宝\",\"appVersion\":\"1.4.9.2\",\"clientType\":\"android\",\"deviceModel\":\"Redmi Note 2\",\"deviceName\":\"Xiaomi\",\"packageName\":\"com.kaicom.ttk\",\"sdkVersion\":\"3.4.0\"}");
CainiaoYimaUrlrouteGetlistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_urlroute_getlist_response>
    <status_code>2</status_code>
    <data>
        <content>{&quot;xxxkey1&quot;:&quot;xxxValue1&quot;,&quot;xxxkey2&quot;:&quot;xxxValue2&quot;}</content>
        <route_version_map>{&quot;K_TTKD&quot;:&quot;7&quot;, &quot;K_YTO&quot;:&quot;13&quot;}</route_version_map>
    </data>
    <is_success>true</is_success>
    <status_message>调用成功</status_message>
</cainiao_yima_urlroute_getlist_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

返回
顶部