koubei.retail.item.query (查询快消行业商品详情)

口碑和淘鲜达、盒马进行合作,需要口碑提供券详情信息查询接口

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
item_id String 必须 32 支付宝商品ID,即展示的券 2015111700076000000003467287
city_id String 必须 6 城市编码,6位国际码 900100

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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_id String 必填 32 商品id 2017111010076000000019183770
title String 必填 20 券名称 单品代金券
item_status String 选填 20 商品状态,共有5个状态:INIT(初始状态)EFFECTIVE(生效)PAUSE(暂停)FREEZE(冻结)INVALID(失效) EFFECTIVE
type String 必填 20 券类型:CASH为代金券,DISCOUNT为折扣券;ALL为全场,SINGLE为单品 ALL_CASH
discount_rate String 选填 5 折扣比例,5折:0.5 0.5
value_amount Price 选填 10 代金券金额:满100减30 => 30。单位为元,精确到小数点后两位,取值范围[0.01,100000000] 12
original_amount Price 选填 10 商品原价(减至券)。单位为元,精确到小数点后两位,取值范围[0.01,100000000] 100
reduce_to_amount Price 选填 10 优惠价(减至券)。单位为元,精确到小数点后两位,取值范围[0.01,100000000] 15
gmt_start String 选填 20 商品生效时间 2017-01-01 00:00:00
gmt_end String 选填 20 商品失效时间 2017-01-01 00:00:00
descriptions RetailItemDescription [] 选填 - 商品描述
  • └ title
  • String
  • 选填
  • 15
  • 商品描述title
  • 有效期
  • └ details
  • String []
  • 选填
  • 1000
  • 标题下的描述列表,列表类型,每项不得超过100个中文字符,最多10项
  • 领券后10内有效
cover String 选填 100 封面图url地址 http://dl.django.t.taobao.com/rest/1.0/image?fileIds=8lFHhi8LTFicEOGLq_y5MgAAACMAAQQD
picture_list String [] 选填 8 商品详情图片列表 http://dl.django.t.taobao.com/rest/1.0/image?fileIds=8lFHhi8LTFicEOGLq_y5MgAAACMAAQQD,http://dl.django.t.taobao.com/rest/1.0/ima
sku_list String [] 选填 200000 适用的sku列表,最多支持800个SKU,超过返回为空 6928804016260,6928804016262
shop_list String [] 必填 20000 商品适用的门店信息列表 2015112000077000000005528437,2015112000077000000005528438

请求示例

  • 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");
KoubeiRetailItemQueryRequest request = new KoubeiRetailItemQueryRequest();
request.setBizContent("{" +
"\"item_id\":\"2015111700076000000003467287\"," +
"\"city_id\":\"900100\"" +
"}");
KoubeiRetailItemQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"koubei_retail_item_query_response":{
		"msg":"Success",
		"code":"10000",
		"reduce_to_amount":15,
		"item_id":"2017111010076000000019183770",
		"value_amount":12,
		"title":"单品代金券",
		"item_status":"EFFECTIVE",
		"type":"ALL_CASH",
		"discount_rate":"0.5",
		"descriptions":[
			{
				"details":[
					"领券后10内有效"
				],
				"title":"有效期"
			}
		],
		"cover":"http://dl.django.t.taobao.com/rest/1.0/image?fileIds=8lFHhi8LTFicEOGLq_y5MgAAACMAAQQD",
		"shop_list":[
			"2015112000077000000005528437",
			"2015112000077000000005528438"
		],
		"gmt_start":"2017-01-01 00:00:00",
		"sku_list":[
			"6928804016260",
			"6928804016262"
		],
		"original_amount":100,
		"picture_list":[
			"http://dl.django.t.taobao.com/rest/1.0/image?fileIds=8lFHhi8LTFicEOGLq_y5MgAAACMAAQQD",
			"http://dl.django.t.taobao.com/rest/1.0/ima"
		],
		"gmt_end":"2017-01-01 00:00:00"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统错误 联系口碑技术进行问题排查
ILLEGAL_PARAMETERS 参数错误 请检查参数是否正确
ITEM_QUERY_ERROR 查询商品失败 商品id不存在或者商品后台系统有问题

公共错误码

返回
顶部