开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
支付产品
私域产品
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
小程序服务
订单中心
小程序开发管理
生物核身
交易组件
小程序商品
接入指南
api 列表
普通商品
普通商品履约模版
本地生活商品
支付宝文件
商品变更相关
商品营销相关
相关资料
支付有礼
商家粉丝群
营销产品
资金产品
会员产品
信用产品
广告产品
开发 > 服务端 > 私域产品 > 小程序产品 > 权限集列表 > 小程序商品 > api 列表 >  > 小程序商品分页查询接口
已更新
文档更新记录 >
收藏
订阅更新
我的文档
设置
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
查询appid下对应的商品列表(最新版本)

公共请求参数

参数类型是否必选最大长度描述示例值
app_idstring必选32
支付宝分配给开发者的应用id
2014072300007148
methodstring必选128
接口名称
alipay.open.app.item.list.query
formatstring可选40
仅支持json
json
charsetstring必选10
请求使用的编码格式,如utf-8,gbk,gb2312等
utf-8
sign_typestring必选10
商户生成签名字符串所使用的签名算法类型,目前支持rsa2和rsa,推荐使用rsa2
rsa2
signstring必选344
商户请求参数的签名串,详见签名
详见示例
timestampstring必选19
发送请求的时间,格式"yyyy-mm-dd hh:mm:ss"
2014-07-24 03:07:50
versionstring必选3
调用的接口版本,固定为:1.0
1.0
app_auth_tokenstring可选40
biz_contentstring必选
请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

业务请求参数

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"
}' 
说明:本示例仅供参考。

公共响应参数

参数类型是否必选最大长度描述示例值
codestring必选-
网关返回码,
40004
msgstring必选-
网关返回码描述,
business failed
sub_codestring可选-
业务返回码,参见具体的api接口文档
acq.trade_has_success
sub_msgstring可选-
业务返回码描述,参见具体的api接口文档
交易已被支付
signstring必选-
签名,
dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

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,或已做相关授权
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
为开发者能享受更简单的协议处理逻辑、更丰富的开源工具配套、更低的接口响应时延,支付宝开放平台推出符合oas3.0规范的,助力开发体验。新版本文档请点击“查看v3版本”进行访问。
网站地图