koubei.marketing.data.mall.shopitems.query(商圈门店以及门店下面优惠券商品信息) 在线调试(沙箱环境)

查询商圈门店以及门店下面优惠券商品信息

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 可选 32 蚂蚁统一会员ID 123123
mall_id String 必选 32 商圈id 123123
collect_type String 可选 10 查询内容范围 STORES
page_no Number 可选 10 分页码 1
page_size String 可选 10 分页个数 10
max_items_num String 可选 10 最多商品个数 4
max_coupons_num String 可选 10 最多优惠券个数 3
product_id String 可选 50 设备号 A1231
product_version String 可选 50 设备版本号 1.232a

响应参数

参数 类型 是否必填 最大长度 描述 示例值
shop_list TBMiniShopBo 选填 店铺信息
shop_id String 必填 32 口碑店铺id 123123
mini_shop_id String 必填 32 轻店铺id 123123
shop_name String 必填 50 店铺名 肯德基z空间店
shop_head_name String 必填 50 主店名 肯德基
address String 必填 100 门店地址 西溪路556号
logo_url String 必填 200 门店图片url http://image.com/url
items ItemBo[] 可选 2000 商品信息
name String 必填 20 名称 鸡翅
logo String 必填 50 logo链接 http://image.com
origin_price Number 必填 10 原价 10
price Number 必填 10 现价 4
desc String 可选 200 描述信息 100代200代金券
attribute String 必填 2000 json 字符串表示额外信息 {"url":"image"}
coupons ItemBo[] 可选 2000 优惠券信息
name String 必填 20 名称 鸡翅
logo String 必填 50 logo链接 http://image.com
origin_price Number 必填 10 原价 10
price Number 必填 10 现价 4
desc String 可选 200 描述信息 100代200代金券
attribute String 必填 2000 json 字符串表示额外信息 {"url":"image"}
attribute String 必填 2000 json 字符串 {"url":"image"}

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingDataMallShopitemsQueryRequest request = new KoubeiMarketingDataMallShopitemsQueryRequest();
request.setBizContent("{" +
"\"user_id\":\"123123\"," +
"\"mall_id\":\"123123\"," +
"\"collect_type\":\"STORES\"," +
"\"page_no\":1," +
"\"page_size\":\"10\"," +
"\"max_items_num\":\"4\"," +
"\"max_coupons_num\":\"3\"," +
"\"product_id\":\"A1231\"," +
"\"product_version\":\"1.232a\"" +
"  }");
KoubeiMarketingDataMallShopitemsQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_marketing_data_mall_shopitems_query_response": {
        "code": "10000",
        "msg": "Success",
        "shop_list": [
            {
                "shop_id": "123123",
                "mini_shop_id": "123123",
                "shop_name": "肯德基z空间店",
                "shop_head_name": "肯德基",
                "address": "西溪路556号",
                "logo_url": "http://image.com/url",
                "items": [
                    {
                        "name": "鸡翅",
                        "logo": "http://image.com",
                        "origin_price": 10,
                        "price": 4,
                        "desc": "100代200代金券",
                        "attribute": "{\"url\":\"image\"}"
                    }
                ],
                "coupons": [
                    {
                        "name": "鸡翅",
                        "logo": "http://image.com",
                        "origin_price": 10,
                        "price": 4,
                        "desc": "100代200代金券",
                        "attribute": "{\"url\":\"image\"}"
                    }
                ],
                "attribute": "{\"url\":\"image\"}"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
BIZ_ERROR 业务异常 请联系口碑开发
INVALID_PARAMETER 参数有误 请检查参数
SYSTEM_ERROR 系统繁忙 请联系口碑开发
onlineServer