查询商户录入的所有商品ID接口和商品详情接口,两个接口合并为一个接口,koubei.item.batchquery 商品信息查询
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | koubei.item.batchquery |
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 | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
page_no | String | 可选 | 9 | 页码,留空标示第一页,默认10个结果为一页 | 1 |
page_size | Number | 可选 | 30 | 每页记录数,默认10,最大20 | 10 |
item_ids | String | 可选 | 32 | 商品Id,多个用,分割,最多支持传5个,如果不传递则查询商户下所有商品,但是不返回适用门店字段,使用了该参数,则无需填写page_no和page_size | 2015052100077000000000120773 |
operation_context | KoubeiOperationContext | 可选 | - | 操作上下文 isv角色操作时必填;其他角色不需填写 | - |
|
|||||
auth_code | String | 可选 | 64 | 服务商、服务商员工、商户、商户员工等口碑角色操作时必填,对应为《koubei.member.data.oauth.query》中的auth_code,默认有效期24小时; | 6a8713a414da4a2dafdb7c24e597TX80 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
page_size | String | 必填 | 3 | 每页记录数 | 20 |
current_page_no | String | 必填 | 9 | 当前页码 | 1 |
total_page_no | String | 必填 | 9 | 总页码数目 | 3 |
total_items | String | 必填 | 9 | 总共商品数目 | 50 |
item_infos | ItemQueryResponse [] | 必填 | - | 商品信息 | |
|
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); KoubeiItemBatchqueryRequest request = new KoubeiItemBatchqueryRequest(); request.setBizContent("{" + "\"page_no\":\"1\"," + "\"page_size\":10," + "\"item_ids\":\"2015052100077000000000120773\"," + "\"operation_context\":{" + "\"op_role\":\"MERCHANT\"" + " }," + "\"auth_code\":\"6a8713a414da4a2dafdb7c24e597TX80\"" + " }"); KoubeiItemBatchqueryResponse response = alipayClient.execute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "koubei_item_batchquery_response":{ "msg":"Success", "code":"10000", "total_page_no":"3", "current_page_no":"1", "total_items":"50", "item_infos":[ { "original_price":100.00, "picture_details":"商品图片", "item_id":"20161011111111111111113", "item_type":"TRADE_VOUCHER", "subject":"商品A", "tb_cover":"r3xDgvHISgKTRZ9QKmdVZQAAACMAAQED", "weight":1, "memo":"备注", "pic_coll":[ "{\"IUFIDASFIEUIOFKSFIUFE83IEI\":\"http://object.alipay.com/getpic.do?kjkdjkjj\"}" ], "item_status":"EFFECTIVE", "inventory":1000, "descriptions":[ { "details":[ "小标题下方的描述文案" ], "title":"小标题" } ], "cover":"0yaPA96AQPqJDIju28pvAgAAACMAAQEC", "gmt_start":"2016-10-07 11:30:24", "category_id":"2017042500132112", "price":50.00, "trade_voucher_item_template":{ "support_book":"T", "buyer_notes":[ { "details":[ "小标题下方的描述文案" ], "title":"小标题" } ], "validity_period":"200" }, "shop_ids":"2015100300077000000001860010,2015100100077000000001855137", "price_mode":"FIX" } ], "page_size":"20" } }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "koubei_item_batchquery_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" } }
错误码 | 错误描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 系统繁忙 | 发生系统异常,请稍后重试 |
INVALID_PARAMETER | 非法参数 | 请参考接口文档,检查入参是否满足要求。 |
AUTH_CODE_VALIDATE_FAIL | auth code验证失败 | 传入正确的auth code |
BIZ_ERROR | 业务异常底层业务错误,请参考返回信息处理 | 底层业务错误,请参考返回信息处理 |