店铺分页查询接口

用于服务商或商户查询其自己的店铺信息

公共请求参数

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

请求参数

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
商户角色ID	ip_role_id	String	必选	32	商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。特别说明：IoT设备三绑定场景统一填写商户pid	2088301155943087
页码	page_num	Number	必选	32	查询页数	1
每页查询大小	page_size	Number	必选	3	每页查询大小，限制100以内	10
行政区划版本	address_version	String	可选	32	行政区划版本，当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本)，其中空值默认为：2020Q1版本(address_version=''或null)，想要查看版本是2022年2季度版本则传入:(address_version='2022Q2')，想要获取最新版本则传入:(address_version ='UPTODATE')	2022Q2

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
code	String	必选	-	网关返回码,详见文档	40004
msg	String	必选	-	网关返回码描述,详见文档	Business Failed
sub_code	String	可选	-	业务返回码，参见具体的API接口文档	ACQ.TRADE_HAS_SUCCESS
sub_msg	String	可选	-	业务返回码描述，参见具体的API接口文档	交易已被支付
sign	String	必选	-	签名,详见文档	DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
门店详情	shop_infos	ShopQueryOpenApiVO[]	必选		门店详情
总页数	total_pages	Number	必选	10	总页数	10

请求示例

Java

PHP

HTTP

响应示例

json

xml

{
    "ant_merchant_expand_shop_page_query_response": {
        "code": "10000",
        "msg": "Success",
        "shop_infos": [
            {
                "shop_id": "2018011900502000000005124744",
                "business_address": {
                    "city_code": "371000",
                    "district_code": "371002",
                    "address": "万塘路18号黄龙时代广场B座",
                    "province_code": "370000",
                    "poiid": "B0FFIVU189",
                    "longitude": "120.760001",
                    "latitude": "60.270001",
                    "type": "BUSINESS_ADDRESS"
                },
                "shop_category": "1001",
                "new_shop_category": "B0001",
                "store_id": "NO0001",
                "shop_type": "01",
                "shop_name": "支付宝东门小卖铺",
                "contact_phone": "010-62286228",
                "contact_mobile": "13901390139",
                "business_time": [
                    {
                        "week_day": 1,
                        "open_time": "09:30",
                        "close_time": "22:00"
                    }
                ],
                "shop_status": "01",
                "shop_info_status": "01"
            }
        ],
        "total_pages": 10
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

**说明：**本示例仅供参考。

异常示例

json

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

错误码

公共错误码

前往查看

业务错误码

错误码	错误描述	解决方案
SYSTEM_ERROR	系统繁忙	服务器异常可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
ADDRESS_VERSION_CODE_ILLEGAL	地址版本非法	传入指定的地址版本
MERCHANT_NOT_EXIST	查询商户不存在	查询商户不存在
MER_ARGUMENT_NULL	入参为空	入参对象为空，请按照接口描述填入正确参数
NOT_ALLOWED_SETTLE	未经商户ip_role_id授权，不允许查询	未经商户ip_role_id授权，不允许查询

店铺分页查询接口

公共请求参数#

请求参数#

公共响应参数#

响应参数#

请求示例#

响应示例#

异常示例#

错误码#

公共错误码#

业务错误码#

公共请求参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

错误码

公共错误码

业务错误码