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

cainiao.yima.sdk.delivery.area.config.query (查询揽收范围入口和提示弹窗配置)

查询揽收范围入口和提示弹窗配置

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
location String 必须 116.310003,39.991957 定位的经纬度,格式:"116.310003,39.991957"
cp_code String 必须 K_TTKD cpCode
session_code String 必须 07646da4cebb4148a53ba54dd077ccfe sessionCode
user_id Number 必须 4398046715399 userId

响应参数

名称 类型 示例值 描述
data DispatchAreaConfigDto data 出参
  • └ message
  • String
  • 来维护揽收范围吧
  • 弹窗显示内容
  • └ show_dialog
  • Boolean
  • true
  • 是否显示弹出提示
  • └ show_negative_button
  • Boolean
  • true
  • 是否显示取消按钮
  • └ title
  • String
  • 标题
  • 弹窗提示标题
status_code String 2 状态码
status_message String error 状态描述
is_success Boolean true 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaSdkDeliveryAreaConfigQueryRequest req = new CainiaoYimaSdkDeliveryAreaConfigQueryRequest();
req.setLocation("116.310003,39.991957");
req.setCpCode("K_TTKD");
req.setSessionCode("07646da4cebb4148a53ba54dd077ccfe");
req.setUserId(4398046715399L);
CainiaoYimaSdkDeliveryAreaConfigQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_sdk_delivery_area_config_query_response>
    <data>
        <message>来维护揽收范围吧</message>
        <show_dialog>true</show_dialog>
        <show_negative_button>true</show_negative_button>
        <title>标题</title>
    </data>
    <status_code>2</status_code>
    <status_message>error</status_message>
    <is_success>true</is_success>
</cainiao_yima_sdk_delivery_area_config_query_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

返回
顶部