koubei.catering.itemlist.query (口碑餐饮行业商品列表查询接口)

isv查询口碑餐饮商品列表

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
operator_type String 可选 20 操作人员身份类型。如果是isv代操作,请传入ISV;如果是商户操作请传入MERCHANT;如果是商户员工则传入M_STAFF MERCHANT
request_id String 必须 64 请求id。支持英文字母和数字,由开发者自行定义(不允许重复) 2016102903214476899999999
page_no Number 必须 64 页码数,整数,表示需要查询第几页数据。 1
page_size Number 必须 64 列表每页显示商品的条目数,整数 10
auth_code String 可选 64 服务商、服务商员工、商户、商户员工等口碑角色操作时必填,对应为《koubei.member.data.oauth.query》中的auth_code,默认有效期24小时;isv自身角色操作的时候,无需传该参数 6a8713a414da4a2dafdb7c24e597TX80
item_status String 可选 64 查询特定状态的商品。状态枚举值为:INIT表示未上架,EFFECTIVE表示已上架,PAUSE表示已暂停, FREEZE表示已冻结, INVALID表示已下架。如果为空则默认查询所有状态商品 EFFECTIVE

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
request_id String 必填 64 请求id。支持英文字母和数字,由开发者自行定义(不允许重复) 2016102903214476899999999
item_list CaterItemListInfo [] 必填 - 商品摘要信息列表
  • └ subject
  • String
  • 必填
  • 60
  • 商品名称,请勿超过60个字符
  • 鱼香肉丝杨梅汁套餐
  • └ original_price
  • Price
  • 必填
  • 20
  • 商品原价。字符串,单位元,2位小数
  • 120.12
  • └ price
  • String
  • 必填
  • 20
  • 商品现价。字符串,单位元,两位小数
  • 119.99
  • └ inventory
  • Number
  • 必填
  • 20
  • 商品剩余库存数量
  • 123
  • └ gmt_modified
  • Date
  • 必填
  • 50
  • 商品最后修改时间。格式为YYYY-MM-DD HH:mm:ss
  • 2016-10-07 11:30:24
  • └ validity_period
  • Number
  • 必填
  • 16
  • 购买有效期:商品自购买起多长时间内有效,取值范围 7-360,单位天。举例,如果是7的话,是到第七天晚上23:59:59失效。商品购买后,没有在有效期内核销,则自动退款给用户。举例:买了一个鱼香肉丝杨梅汁套餐的商品,有效期一个月,如果一个月之后,用户没有消费该套餐,则自动退款给用户
  • 360
  • └ item_status
  • String
  • 必填
  • 20
  • 当前商品状态。状态枚举值为:INIT表示初始状态, EFFECTIVE表示生效状态,PAUSE表示暂停售卖,FREEZE表示冻结,INVALID表示失效状态
  • INIT
  • └ reject_reason
  • String
  • 必填
  • 64
  • 已退回商品退回原因
  • 优惠价格太低,退回修改
  • └ item_id
  • String
  • 必填
  • 64
  • 口碑体系内部商品的唯一标识
  • 2015090300006123123213213
total_amount Number 必填 64 当前可查询商品总条目数 100

请求示例

  • 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");
KoubeiCateringItemlistQueryRequest request = new KoubeiCateringItemlistQueryRequest();
request.setBizContent("{" +
"\"operator_type\":\"MERCHANT\"," +
"\"request_id\":\"2016102903214476899999999\"," +
"\"page_no\":1," +
"\"page_size\":10," +
"\"auth_code\":\"6a8713a414da4a2dafdb7c24e597TX80\"," +
"\"item_status\":\"EFFECTIVE\"" +
"  }");
KoubeiCateringItemlistQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"koubei_catering_itemlist_query_response":{
		"msg":"Success",
		"code":"10000",
		"total_amount":100,
		"item_list":[
			{
				"original_price":120.12,
				"item_id":"2015090300006123123213213",
				"subject":"鱼香肉丝杨梅汁套餐",
				"price":"119.99",
				"validity_period":360,
				"reject_reason":"优惠价格太低,退回修改",
				"inventory":123,
				"gmt_modified":"2016-10-07 11:30:24",
				"item_status":"INIT"
			}
		],
		"request_id":"2016102903214476899999999"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
ITEM_OPERATION_ERROR 商品操作异常 重试或等待异步通知
SYSTEM_ERROR 系统繁忙 重试或联系技术人员协助
ITEM_ILLEGAL_PARAMS 商品操作参数异常 对照接口文档以及请求参数用例,修改请求参数
ITEM_FROBIDDEN_WORD 商品操作包含违禁词 去掉请求中的非法关键字
ITEM_SPECIAL_CHAR 商品操作包含特殊字符 检查并修改商品操作中特殊字符
QUERY_NO_DATA 查询无相关商品数据 检查查询入参是否正确
SYSTEM_UPDATE 系统升级中,请稍后再试 请稍后再试,或联系客服询问具体原因
INVALID_PARAMETER 参数有误 对照接口文档以及请求参数用例,修改请求参数
AUTH_CODE_VALIDATE_FAIL authcode检查失败 可能不存在或已失效 根据文案提示自查 是否为合法authcode 且 authcode授权是否已失效
ITEM_UNIQUE_VIOLATION 唯一性约束报错,重复请求 当前request_id的请求已经被受理,如果是新请求,需更换request_id
SYSTEM_ERROR 系统繁忙 重试或联系技术人员协助
NO_PERMISSION 无调用接口权限 请联系工作人员添加权限
BIZ_ERROR 业务异常 根据错误描述排查原因
INVALID_PARAMETER 参数有误biz_content的json格式错误 检查入参后重新请求

公共错误码

返回
顶部