koubei.marketing.data.trade.habbit.query(商户会员交易习惯查询接口) 在线调试(沙箱环境)

用于商户会员交易习惯查询

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
biz_date String 必选 255 业务日期 20161025
store_ids String 可选 1024 门店列表,门店用逗号分割,最多支持10个门店。
不填时,则为商户维度汇总数据
2016070500077000000016190907,2016070500077000000016190908,2016070500077000000016190909

响应参数

参数 类型 是否必填 最大长度 描述 示例值
trade_habit_info String 必填 40960 biz_date: 业务日期 格式:yyyyMMdd
partner_industry_type:商户行业标识(轻餐or正餐)
shop_id: 门店id
shop_name: 门店名称
trade_again_ratio_7d: (近7天)复购率
trade_again_ratio_active_7d: (近7天)复购率(口碑活跃用户)
trade_user_cnt_7d: (近7天)交易会员数
trade_user_cnt_active_7d: (近7天)交易活跃会员数(口碑活跃用户贡献)
zdj_order_amt_7d: (近7天)桌单价(订单金额)(单位:分)
zdj_service_amt_7d: (近7天)桌单价(实收金额)(单位:分)
zdj_service_amt_distribution_7d: (近7天)桌单价(实收金额)段分布(示例:0-15:0.2799,15-20:0.1775,20-25:0.1058,25-30:0.0956,30-35:0.0648,35-40:0.0751,40-45:0.0444,45-50:0.0137,50-55:0.0171,55及以上:0.1263 意思是消费0-15元的比例占消费总人数的0.2799)
注意:出参中还包含30天/60天/90天的类似指标,篇幅有限不一一列举
[{"biz_date":"20161025", "shop_id":"1001", "trade_again_ratio_7d":"0.5", "trade_again_ratio_active_7d":"0.8"}]

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingDataTradeHabbitQueryRequest request = new KoubeiMarketingDataTradeHabbitQueryRequest();
request.setBizContent("{" +
"\"biz_date\":\"20161025\"," +
"\"store_ids\":\"2016070500077000000016190907,2016070500077000000016190908,2016070500077000000016190909\"" +
"  }");
KoubeiMarketingDataTradeHabbitQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_marketing_data_trade_habbit_query_response": {
        "code": "10000",
        "msg": "Success",
        "trade_habit_info": "[{\"biz_date\":\"20161025\",\r\n    \"shop_id\":\"1001\",\r\n    \"trade_again_ratio_7d\":\"0.5\",\r\n    \"trade_again_ratio_active_7d\":\"0.8\"}]"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 稍后重试
INVALID_PARAMETER 参数有误 检查biz_date参数是否为空,调整参数后重试
onlineServer