alipay.offline.market.shop.batchquery(查询商户的门店编号列表) 在线调试(沙箱环境)

系统商通过该接口可以查询对应APPID下所有的门店编号(支付宝口碑门店编号)

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.offline.market.shop.batchquery
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
page_no String 必选 4 页码,第一页传入"1",默认500个结果为一页。此参数必须是大于0的正整数,为0时将查询报错。 1
biz_channel String 可选 32 表示接口查询门店的业务渠道限制:ALL、 POS、不传。不传代表只查询普通门店,传入POS代表只查询简易门店,传入ALL代表查询普通门店和简易门店。 POS、ALL

响应参数

参数 类型 是否必填 最大长度 描述 示例值
shop_ids String 必填 67000 门店列表ID,逗号分隔 "2015052100077000000000120773","2015052100077000000000120774"
current_pageno String 必填 7 当前页码 1
total_pageno String 必填 4 总页码数目 3

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOfflineMarketShopBatchqueryRequest request = new AlipayOfflineMarketShopBatchqueryRequest();
request.setBizContent("{" +
"\"page_no\":\"1\"," +
"\"biz_channel\":\"POS、ALL\"" +
"  }");
AlipayOfflineMarketShopBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_offline_market_shop_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "shop_ids": [
            "\"2015052100077000000000120773\"",
            "\"2015052100077000000000120774\""
        ],
        "current_pageno": "1",
        "total_pageno": "3"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAM 接口输入参数不合法 对照接口文档,检查传入参数。
SYSTEM_ERROR 系统异常,操作失败 稍后进行重试
onlineServer