基础 qianmi.cloudshop.logistics.address.search(查询商家地址库信息)

通过此接口查询商家地址库信息,用于发货接口,需要分销商授权
 用户授权类型
 公共参数
请求地址:
环境 HTTP请求地址 HTTPS请求地址
正式环境 http://gw.api.qianmi.com/api https://api.qianmi.com/api
系统级请求参数:
名称 类型 是否必须 描述
methodString 必须 API接口名称
access_tokenString 可选 用户登录授权以后,QMOP颁发给应用的授权信息,详细介绍请点击这里,当前API的用户授权类型标明:"需要授权",则此参数必传,"不需要授权",则此参数不需要传。
formatString 必须 指定响应格式,目前支持格式为json
appKeyString 必须 分配给应用的AppKey
vString 必须 API协议版本,当前可选值:1.1
signString 必须 API输入参数签名结果
timestampString 必须 请求时间戳,时区为GMT+8(北京时间),格式:"yyyy-MM-dd HH:mm:ss",例如"2012-12-20 10:20:35",开放平台允许客户端请求的最大时间误差为10分钟
 业务参数
名称 类型 是否必须 示例值 默认值 描述
rdefString 可选 send_def no_def查询非默认地址 send_def 查询默认发货地址 get_def查询默认提货地址 cancel_def查询默认退货地址 receive_def查询默认收货地址 缺省:获取所有地址
fieldsField List 必须 seller_nick,contact_id 需要返回的字段,多个字段之间以逗号隔开
 请求示例
OpenClient client = new DefaultOpenClient(url, appKey, appSecret);
LogisticsAddressSearchRequest req = new LogisticsAddressSearchRequest();
req.setRdef("no_def");
req.setFields("contact_id,seller_nick,contact_name,province,city,country,addr,zip,mobile,phone,send_def,cancel_def,get_def,modified,area_id,memo");
LogisticsAddressSearchResponse response = client.execute(req, accessToken);
$client = new OpenClient;
$client->appKey = appKey;
$client->appSecret = appSecret;
$req = new LogisticsAddressSearchRequest;
$req->setRdef("no_def");
$req->setFields("contact_id,seller_nick,contact_name,province,city,country,addr,zip,mobile,phone,send_def,cancel_def,get_def,modified,area_id,memo");
$res = $client->execute($req, $accessToken);
IOpenClient client = new DefaultOpenClient(url, appKey, appSecret);
LogisticsAddressSearchRequest req = new LogisticsAddressSearchRequest();
req.Rdef = "no_def";
req.Fields = "contact_id,seller_nick,contact_name,province,city,country,addr,zip,mobile,phone,send_def,cancel_def,get_def";
LogisticsAddressSearchResponse response = client.Execute(req, accessToken);
 响应参数
名称 类型 示例值 描述
address AddressResult[] 地址库列表
 响应示例

JSON数据格式:

 异常示例

JSON数据格式:

 {
    "errorToken": "@@$-ERROR_TOKEN$-@@",
    "code": "33",
    "message": "非法的参数",
    "solution": "请查看根据服务接口对参数格式的要求",
    "subErrors": {
      "subError": [{
          "code": "isv.invalid-paramete:XXXX",
          "message": "参数XXXX无效,格式不对、非法值、越界等"
        }]
  }
 错误码
错误码 错误描述 解决方案
isv.qianmi-cloudshop-logistics-address-search-service-error:01063010地址类型无效请参考输入参数中对rdef参数的定义
 FAQ