ant.merchant.expand.merchant.storelist.query(商户外部门店查询接口) 在线调试(沙箱环境)

查询商户外部门店

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 ant.merchant.expand.merchant.storelist.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
pid String 可选 16 指定的商户pid,如果指定, 只返回此pid的店铺信息。(此pid必须是商户自己的) 2088202967380463
is_include_cognate String 可选 32 可选: true / false 。
当is_include_cognate = true , 指定pid为空, 查询商户下所有pid的店铺
当is_include_cognate = true ,指定pid不为空时,查询指定pid的店铺
当is_include_cognate = false ,指定pid为空时, 查询当前商pid的店铺
当is_include_cognate = false ,指定pid不为空时,查询指定pid的店铺
false
page_num Number 可选 10 页码,必须为大于0的整数, 1表示第一页,2表示第2页,依次类推。 1
page_size Number 可选 2 每页记录条数,必须为大于0的整数,最大值为30 20

响应参数

参数 类型 是否必填 最大长度 描述 示例值
total_pages Number 必填 10 总页数 20
page_num Number 必填 10 当前页码,页码从1开始 3
page_size Number 必填 10 每页条数 15
total_size Number 必填 10 总条数 298
merchant_stores ShopQueryInfo 选填 商户门店列表
pid String 必填 128 商户pid 2088301083271168
shop_id String 必填 128 内部门店ID xxx
store_id String 必填 128 外部门店ID xxx
name String 必填 256 门店名称 肯德风味鸡腿广州龙归店
address String 必填 1024 门店地址 广东省广州市白云区太和镇夏良村
shop_type String 可选 128 门店类型 直营店
longitude String 可选 128 经度 120.4068937174479
latitude String 可选 128 纬度 36.39955050998264

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AntMerchantExpandMerchantStorelistQueryRequest request = new AntMerchantExpandMerchantStorelistQueryRequest();
request.setBizContent("{" +
"\"pid\":\"2088202967380463\"," +
"\"is_include_cognate\":\"false\"," +
"\"page_num\":1," +
"\"page_size\":20" +
"}");
AntMerchantExpandMerchantStorelistQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "ant_merchant_expand_merchant_storelist_query_response": {
        "code": "10000",
        "msg": "Success",
        "total_pages": 20,
        "page_num": 3,
        "page_size": 15,
        "total_size": 298,
        "merchant_stores": [
            {
                "pid": "2088301083271168",
                "shop_id": "xxx",
                "store_id": "xxx",
                "name": "肯德风味鸡腿广州龙归店",
                "address": "广东省广州市白云区太和镇夏良村",
                "shop_type": "直营店",
                "longitude": "120.4068937174479",
                "latitude": "36.39955050998264"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "ant_merchant_expand_merchant_storelist_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
PERMISSION_DENIED 没有查询指定PID门店的权限 请确认是否有查询门店的权限,请检查指定的pid是否属于当前商户
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
INVALID_PARAMETER 参数有误 检查入参对象 或 必填的参数内容是否为空
BIZ_ERROR 业务异常没有找到对应商户 联系技术支持
onlineServer