通用场景
分页查询小程序本地商品
注意：
查询appid下对应的本地商品列表(最新版本)
公共请求参数
业务请求参数
page_num｜页码必选number(5)
【描述】查询页码
【示例值】1
page_size｜单页大小必选number(5)
【描述】查询分页单页数量，不超过20
【示例值】10
以下参数 二选一 传入必选
item_id_list｜平台侧商品id列表string[](2000)
【描述】支付宝平台侧商品id 列表，最多20个。
【示例值】["2023010122000000000001"]
out_item_id_list｜商家侧id列表string[](2000)
【描述】商家侧商品id 列表，最多20个。 与item_id_list二选一。如果都传，优先使用商家侧商品id。
【示例值】["12345"]
spu_status｜商品spu状态可选string(20)
【描述】spu商品状态
【枚举值】
审核驳回: audit_reject
审核中: auditing
已下架: delisting
【示例值】available
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.localitem.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)
【描述】符合条件的商品总数
【示例值】100
items｜商品列表可选localitemvo[]
【描述】商品列表
out_item_id｜商家侧商品id必选string(100)
【描述】商家侧商品id
【示例值】12345
item_id｜支付宝平台侧商品id必选string(64)
【描述】支付宝平台侧商品id，是支付宝平台侧商品的唯一标识，后续与平台交互，需要使用该 id，建议持久化。
【示例值】2023010122000000000001
title｜商品名称必选string(60)
【描述】商品名称，字符类型，最少不低于3，最长不超过60个字。注：1.商品标题只允许汉字、数字、英文字母、特殊字符集；2.商品标题不得仅为数字、字母、特殊字符集或上述三种的组合。
【示例值】美味甜甜圈代金券
item_type｜商品模版类型必选string(5)
【描述】商品模版类型： 1. 团购 2. 代金 3. 次卡
【枚举值】
团购: 1
代金: 2
次卡: 3
【示例值】1
head_img｜商品主图必选string(128)
【描述】商品主图链接
【示例值】https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original
path｜商品详情页链接必选string(512)
【描述】商品详情页链接
【示例值】alipays://platformapi/startapp?appid=88888&page=test
category_id｜平台类目id必选string(64)
【描述】平台类目，填写的类目必须在类目表列出，多级类目只填最后一级。商品类目 id 及信息可通过商品类目表获取。
【示例值】c1234567
spu_status｜商品状态必选string(10)
【描述】审核驳回：商品审核失败时，商品状态为审核驳回。 审核中：商品处于审核流程中时，商品状态为审核中。 已下架：商家可以通过调用接口下架商品，也可以通过商家后台下架商品。 可售卖：商家可以通过调用接口上架商品，也可以通过商家后台上架商品。 冻结：当商家出现违规操作时，支付宝侧将发起冻结，商品无法对外透出。 当商品包含多个规格时，只要有一个规格的商品状态为“可售卖”，spu的商品状态则为“可售卖”。
【枚举值】
审核驳回: audit_reject
审核中: auditing
已下架: delisting
【示例值】available
skus｜sku列表必选localitemskuqueryvo[]
【描述】sku数组
sku_id｜支付宝平台侧sku id必选string(64)
【描述】支付宝平台侧商品sku的唯一标识，后续与平台交互，需要使用该 id，建议持久化。
【示例值】2023010123000000000001
sale_price｜sku售价必选number(32)
【描述】sku售价，分为单位
【示例值】100
sale_status｜售卖状态必选string(16)
【描述】sku售卖状态，包含以下两种状态： 已下架(delisting) 可售卖(available)
【示例值】available
out_sku_id｜商家侧skuid可选string(64)
【描述】商家侧sku id，要求 appid 下全局唯一。
【示例值】99999
original_price｜sku原价可选number(32)
【描述】sku原价，分为单位
【示例值】100
stock_num｜sku库存可选number(10)
【描述】sku库存
【示例值】9999
attrs｜sku属性列表可选itemskuattrvo[]
【描述】用于需要透出sku属性的场景。如线路游需要透出sku销售属性
attr_key｜销售属性key必选string(30)
【描述】销售属性key值
【示例值】exmaple_key
attr_value｜销售属性值必选string(50)
【描述】销售属性值
【示例值】example_value
thumb_img_url｜sku图片文件链接可选string(500)
【描述】sku图片afts文件链接，素材中心根据提报时的图片afts文件id自动生成
【示例值】https://mdn.alipayobjects.com/mrch_material/afts/img/a*oowltr67k44aaaaaaaaaaaaadun1aq/original
spu_id｜标品id条件必选string(32)
【描述】标品id
【必选条件】查询日历房商品（item_type=7）时，返回关联的 spu id；查询团购、代金商品时（item_type=1或者2）不返回
【示例值】1
stock_num｜商品库存可选string(10)
【描述】库存
【示例值】9999
merchant_name｜商家名称可选string(60)
【描述】商家名称
【示例值】merchant_name
sold_time｜售卖时间可选timerangestructvo
【描述】start_time描述售卖开始时间，end_time描述售卖结束时间，时间格式均为yyyy-mm-dd hh:mm:ss
start_time｜开始时间必选string(30)
【描述】开始时间，格式为yyyy-mm-dd hh:mm:ss
【示例值】2023-01-01 10:00:00
end_time｜结束时间必选string(30)
【描述】结束时间，格式为yyyy-mm-dd hh:mm:ss
【示例值】2023-01-01 10:00:00
customer_service_mobile｜客服电话可选phonestructvo
【描述】客服电话，包含区号 电话号码的座机号码格式，以及手机号码格式
phone_type｜电话类型条件必选string(5)
【描述】电话类型
【枚举值】
手机号: 1
座机: 2
【必选条件】填写电话号码时需指定手机号或者座机号
【示例值】1
以下参数 二选一 必选
phone_number｜电话号码string(30)
【描述】电话号码，包含区号 电话号码的座机号码格式，以及手机号码格式
【注意事项】与客服链接至少填写一个
【示例值】156xxxxxx12
customer_link｜客服链接string(500)
【描述】客服链接地址，必须以alipays开头。用户点击链接后可直接进入客服页面进行咨询
【注意事项】与电话号码至少填写一个
【示例值】alipays://*****
item_details_page_model｜c端详情页模式可选string(10)
【描述】1=官方插件版，商品详情页链接不传入 0=自定义详情页版，商品详情页链接必须传入
【示例值】1
attrs｜商品属性可选appitemattrvo
【描述】商品属性
attr_key｜商品属性key必选string(40)
【描述】商品属性key
【示例值】key1
attr_value｜商品属性value必选string(102400)
【描述】商品属性value
【示例值】value1
响应示例
正常示例
异常示例
{
"alipay_open_app_localitem_list_query_response": {
"code": "10000",
"msg": "success",
"page_size": 20,
"page_num": 1,
"total": 100,
"items": [
{
"out_item_id": "12345",
"item_id": "2023010122000000000001",
"title": "美味甜甜圈代金券",
"item_type": "1",
"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",
"merchant_name": "merchant_name",
"sold_time": {
"start_time": "2023-01-01 10:00:00",
"end_time": "2023-01-01 10:00:00"
},
"customer_service_mobile": {
"phone_type": "1",
"phone_number": "156xxxxxx12",
"customer_link": "alipays://*****"
},
"item_details_page_model": "1",
"attrs": {
"attr_key": "key1",
"attr_value": "value1"
},
"skus": [
{
"sku_id": "2023010123000000000001",
"out_sku_id": "99999",
"sale_price": 100,
"original_price": 100,
"sale_status": "available",
"stock_num": 9999,
"attrs": [
{
"attr_key": "exmaple_key",
"attr_value": "example_value"
}
],
"thumb_img_url": "https://mdn.alipayobjects.com/mrch_material/afts/img/a*oowltr67k44aaaaaaaaaaaaadun1aq/original"
}
],
"spu_id": "1"
}
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试 |
| mini_app_not_online | 小程序未上架 | 先上架小程序再操作商品 |
| permission_check_error | 权限校验失败 | 确认当前请求账号是否匹配当前传入pid或alipay_app_id，或已做相关授权 |