通用场景
查询appid下对应的商品列表(最新版本)
公共请求参数
业务请求参数
out_item_id_list|商家侧id列表条件必选string[](2000)
【描述】商家侧商品id 列表,最多20个。
【必选条件】与item_id_list二选一。如果都传,优先使用商家侧商品id。
【示例值】["12345"]
page_num|页码可选number(5)
【描述】查询页码
【示例值】1
page_size|单页大小可选number(5)
【描述】查询分页单页数量,不超过20
【示例值】10
item_id_list|平台侧商品id列表可选string[](2000)
【描述】支付宝平台侧商品id 列表,最多20个。
【示例值】["2023010122000000000001"]
spu_status|商品spu状态可选string(20)
【描述】spu商品状态
【示例值】available
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.item.list.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"page_num":1,
"page_size":10,
"item_id_list":[
"2023010122000000000001"
],
"out_item_id_list":[
"12345"
],
"spu_status":"available"
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
page_size|单页大小必选number(5)
【描述】单页大小
【示例值】20
page_num|页码必选number(5)
【描述】页码
【示例值】1
total|总数必选number(5)
【描述】符合条件的商品spu总数
【示例值】100
items|商品列表可选itemspuvo[]
【描述】商品spu列表
title|商品名称必选string(60)
【描述】商品名称,字符类型,最少不低于3,最长不超过60个字。注:1.商品标题只允许汉字、数字、英文字母、特殊字符集;2.商品标题不得仅为数字、字母、特殊字符集或上述三种的组合。
【示例值】美味甜甜圈
head_img|商品主图必选string(128)
【描述】商品主图链接
【示例值】https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original
category_id|平台类目id必选string(64)
【描述】平台类目,填写的类目必须在类目表列出,多级类目只填最后一级。商品类目 id 及信息可通过商品类目表获取。
【示例值】c1234567
spu_status|商品spu状态必选string(10)
【描述】审核驳回:商品审核失败时,商品状态为审核驳回。 审核中:商品处于审核流程中时,商品状态为审核中。 已下架:商家可以通过调用接口下架商品,也可以通过商家后台下架商品。 可售卖:商家可以通过调用接口上架商品,也可以通过商家后台上架商品。 冻结:当商家出现违规操作时,支付宝侧将发起冻结,商品无法对外透出。 当商品包含多个规格时,只要有一个规格的商品状态为“可售卖”,spu的商品状态则为“可售卖”。
【枚举值】
审核驳回: audit_reject
审核中: auditing
已下架: delisting
【示例值】available
out_item_id|商家侧商品id可选string(100)
【描述】商家侧商品id,要求 appid 下全局唯一。
【示例值】12345
item_id|支付宝平台侧商品id可选string(64)
【描述】支付宝平台侧商品id,是支付宝平台侧商品的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
2023010122000000000001
【示例值】2023010122000000000001
path|商品详情页链接可选string(256)
【描述】商品详情页链接
【示例值】alipays://platformapi/startapp?appid=88888&page=test
stock_num|商品库存可选number(32)
【描述】库存。
目前支持库存区间0~99999
【示例值】9999
响应示例
正常示例
异常示例
{
"alipay_open_app_item_list_query_response": {
"code": "10000",
"msg": "success",
"page_size": 20,
"page_num": 1,
"total": 100,
"items": [
{
"out_item_id": "12345",
"item_id": "2023010122000000000001",
"title": "美味甜甜圈",
"head_img": "https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original",
"path": "alipays://platformapi/startapp?appid=88888&page=test",
"category_id": "c1234567",
"stock_num": 9999,
"spu_status": "available"
}
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
mini_app_not_online | 小程序未上架 | 请先上架当前小程序 |
permission_check_error | 权限校验失败 | 确认当前请求账号是否匹配当前传入pid或alipay_app_id,或已做相关授权 |