alipay.offline.market.shop.discount.query (店铺优惠查询)

基于门店id的优惠查询服务

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
shop_id String 必须 28 门店id,注意:必须传递isv授权商户下的门店,否则无权限查询 2015042400077110000000013301
query_type String 可选 32 查询类型 目前取值:MERCHANT(商户活动), 如果不传递该参数或者指定参数值,出参只返回item_list,discount_list, 反之返回camp_num,camp_list MERCHANT
user_id String 可选 16 用户id,当query_type为MERCHANT时生效,如果查询的优惠活动需要过用户规则,则用户id必须传入,目前只支持查询活动列表的场景 2088302230717298
camp_biz_type_list String [] 可选 32 活动业务类型列表,当query_type为MERCHANT且user_id不为空时生效,对返回结果进行过滤,返回列表中指定业务类型的活动,默认为空,代表不过滤,返回所有活动。业务类型:CONSUME_SEND:消费送;MRT_DISCOUNT:商户立减;OBTAIN:通用领券 OBTAIN

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
item_list ShopDiscountInfo [] 选填 - 商品列表,最大20条,按申领数量排序,注意:如果入参query_type传递了指定的值,该参数将不会返回。只有当query_type不传递时方可返回数据
  • └ subject
  • String
  • 选填
  • 64
  • 优惠信息标题
  • 海飞丝9折
  • └ description
  • String
  • 选填
  • 1000
  • 优惠信息描述
  • 消费可享9折优惠
  • └ promotion_type
  • String
  • 必填
  • 16
  • 优惠类型。
    优惠:discount
    商品:item
  • discount
  • └ cover
  • String
  • 选填
  • 1000
  • 图片url
  • http://dl.django.t.taobao.com/rest/1.0/image?fileIds=TG2ZYGiZTPqsb_zpPvMFEAAAACMAAQED&zoom=720x720
  • └ sales_quantity
  • String
  • 选填
  • 9
  • 已用数量
  • 25
  • └ is_all
  • String
  • 选填
  • 8
  • 是否全场。
    全场:Y,单品:N
  • Y
  • └ item_id
  • String
  • 选填
  • 32
  • 支付宝商品id
  • 2015111700076000000003467287
  • └ purchase_mode
  • String
  • 选填
  • 28
  • 领用模式。自动领用:AUTO_OBTAIN。手动领用:OBTAIN
  • AUTO_OBTAIN
  • └ promo_sub_type
  • String
  • 选填
  • 64
  • 子类型.
    DISCOUNT("折扣券"),CASH("代金券"),EXCHANGE("兑换券"),BUY_SEND("买N送M券"),
  • EXCHANGE
discount_list ShopDiscountInfo [] 选填 - 优惠信息列表,最大20条,按生效时间排序,注意:如果入参query_type传递了指定的值,该参数将不会返回。只有当query_type不传递时方可返回数据
  • └ subject
  • String
  • 选填
  • 64
  • 优惠信息标题
  • 海飞丝9折
  • └ description
  • String
  • 选填
  • 1000
  • 优惠信息描述
  • 消费可享9折优惠
  • └ promotion_type
  • String
  • 必填
  • 16
  • 优惠类型。
    优惠:discount
    商品:item
  • discount
  • └ cover
  • String
  • 选填
  • 1000
  • 图片url
  • http://dl.django.t.taobao.com/rest/1.0/image?fileIds=TG2ZYGiZTPqsb_zpPvMFEAAAACMAAQED&zoom=720x720
  • └ sales_quantity
  • String
  • 选填
  • 9
  • 已用数量
  • 25
  • └ is_all
  • String
  • 选填
  • 8
  • 是否全场。
    全场:Y,单品:N
  • Y
  • └ item_id
  • String
  • 选填
  • 32
  • 支付宝商品id
  • 2015111700076000000003467287
  • └ purchase_mode
  • String
  • 选填
  • 28
  • 领用模式。自动领用:AUTO_OBTAIN。手动领用:OBTAIN
  • AUTO_OBTAIN
  • └ promo_sub_type
  • String
  • 选填
  • 64
  • 子类型.
    DISCOUNT("折扣券"),CASH("代金券"),EXCHANGE("兑换券"),BUY_SEND("买N送M券"),
  • EXCHANGE
camp_num Number 选填 10 返回商户正在进行中的活动记录数,注意:如果入参query_type不传递或者传递错误值,该参数将不会返回。 100
camp_list CampDetailInfo [] 选填 - 返回商户正在进行中的活动摘要列表数据,注意:如果入参query_type不传递或者传递错误值,该参数将不会返回。
  • └ biz_id
  • String
  • 必填
  • 32
  • 业务id,与bizType 一一对应,如:biz_type为消费送,biz_id为消费送活动id
  • 2015112300077000000005682952
  • └ camp_id
  • String
  • 选填
  • 32
  • 活动id
  • 20170503000000000000001003001670
  • └ biz_type
  • String
  • 必填
  • 32
  • 业务类型:CONSUME_SEND:消费送;MRT_DISCOUNT:商户立减;OBTAIN:通用领券
  • CONSUME_SEND
  • └ camp_desc
  • String
  • 必填
  • 1024
  • 活动描述
  • 买单5折,满10可享,最高7元
  • └ begin_time
  • String
  • 必填
  • 32
  • 活动开始时间
  • 2017-07-01 00:00:00
  • └ end_time
  • String
  • 必填
  • 32
  • 活动结束时间
  • 2017-07-20 00:00:00
  • └ win_limit_daily
  • String
  • 必填
  • 5
  • 每人每日参与次数 -1为不限制
  • 10
  • └ win_limit_life
  • String
  • 必填
  • 5
  • 每人总参与次数 -1 为不限制
  • 10
  • └ camp_guide
  • String
  • 选填
  • 4069
  • 需要解析该json串,title为标题,details是描述,多个detail需要换行
  • [{"details":["2017-05-10 00:00至2017-07-25 23:59有效"],"title":"有效期"},{"details":["向店员出示使用"],"title":"使用方式"}]
  • └ rule_flag_list
  • String []
  • 必填
  • 32
  • 活动规则标识列表,列表中存在的标识,代表该活动包含对应的规则。目前只有人群规则一种。标识说明:
    CROWD:人群规则
  • CROWD
  • └ ext_info
  • String
  • 选填
  • 4096
  • 扩展字段信息,用Map对象json串保存
  • {"key":"value"}

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOfflineMarketShopDiscountQueryRequest request = new AlipayOfflineMarketShopDiscountQueryRequest();
request.setBizContent("{" +
"\"shop_id\":\"2015042400077110000000013301\"," +
"\"query_type\":\"MERCHANT\"," +
"\"user_id\":\"2088302230717298\"," +
"      \"camp_biz_type_list\":[" +
"        \"OBTAIN\"" +
"      ]" +
"  }");
AlipayOfflineMarketShopDiscountQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_offline_market_shop_discount_query_response":{
		"msg":"Success",
		"camp_num":100,
		"camp_list":[
			{
				"camp_guide":"[{\"details\":[\"2017-05-10 00:00至2017-07-25 23:59有效\"],\"title\":\"有效期\"},{\"details\":[\"向店员出示使用\"],\"title\":\"使用方式\"}]",
				"win_limit_daily":"10",
				"win_limit_life":"10",
				"biz_type":"CONSUME_SEND",
				"camp_desc":"买单5折,满10可享,最高7元",
				"end_time":"2017-07-20 00:00:00",
				"begin_time":"2017-07-01 00:00:00",
				"camp_id":"20170503000000000000001003001670",
				"biz_id":"2015112300077000000005682952",
				"ext_info":"{\"key\":\"value\"}",
				"rule_flag_list":[
					"CROWD"
				]
			}
		],
		"code":"10000",
		"item_list":[
			{
				"cover":"http://dl.django.t.taobao.com/rest/1.0/image?fileIds=TG2ZYGiZTPqsb_zpPvMFEAAAACMAAQED&zoom=720x720",
				"sales_quantity":"25",
				"promotion_type":"discount",
				"is_all":"Y",
				"item_id":"2015111700076000000003467287",
				"purchase_mode":"AUTO_OBTAIN",
				"subject":"海飞丝9折",
				"promo_sub_type":"EXCHANGE",
				"description":"消费可享9折优惠"
			}
		],
		"discount_list":[
			{
				"cover":"http://dl.django.t.taobao.com/rest/1.0/image?fileIds=TG2ZYGiZTPqsb_zpPvMFEAAAACMAAQED&zoom=720x720",
				"sales_quantity":"25",
				"promotion_type":"discount",
				"is_all":"Y",
				"item_id":"2015111700076000000003467287",
				"purchase_mode":"AUTO_OBTAIN",
				"subject":"海飞丝9折",
				"promo_sub_type":"EXCHANGE",
				"description":"消费可享9折优惠"
			}
		]
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SHOP_DISCOUNT_QUERY_SYSTEM_ERROR 系统异常 请重试
SHOP_DISCOUNT_QUERY_INVALID_PARAMETER 参数无效 请检查参数
SHOP_DISCOUNT_QUERY_NO_PROVIDER_CONTRACT 服务商没签约 需要签约产品
SHOP_DISCOUNT_HAS_NO_PRIVILEGE 商户对门店无权限 请检查门店商户id与授权商户id是否一致

公共错误码

返回
顶部