通用场景
用于查询小程序商品详情及审核、冻结信息
公共请求参数
业务请求参数
以下参数 二选一 传入必选
out_item_id|商家侧商品idstring[1,30]
【描述】商家侧商品id
【注意事项】商家侧商品id,要求 appid 下全局唯一。与item_id不能同时为空,优先使用out_item_id。
【示例值】400000000083044006
item_id|支付宝平台侧商品idstring[1,30]
【描述】支付平台侧商品id
【注意事项】支付宝平台侧商品id,是支付宝平台侧商品的唯一标识。与out_item_id不能同时为空,优先使用out_item_id。
【示例值】2023050921000235000000
need_edit_spu|是否查询编辑版本可选number[0,1]
【描述】是否查询编辑版本,0查询在线版本,1查询编辑版本。默认为0
【示例值】0
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.item.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={
"out_item_id":"400000000083044006",
"item_id":"2023050921000235000000",
"need_edit_spu":0
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
is_online|是否线上版本必选boolean(6)
【描述】商品是否在线版本,true在线,false最新版本
【示例值】false
out_item_id|商家侧商品id必选string(100)
【描述】商家侧商品id,要求 appid 下全局唯一。
【示例值】12345
item_id|支付宝平台侧商品id必选string(64)
【描述】支付宝平台侧商品id,是支付宝平台侧商品的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
【示例值】2023010122000000000001
title|商品名称必选string(60)
【描述】商品名称,字符类型,最少不低于3,最长不超过60个字。注:1.商品标题只允许汉字、数字、英文字母、特殊字符集;2.商品标题不得仅为数字、字母、特殊字符集或上述三种的组合。
美味甜甜圈
【示例值】美味甜甜圈
desc|导购描述必选string(128)
【描述】导购描述,用于介绍商品卖点
【示例值】导购标题1
head_img|商品主图必选string(128)
【描述】商品主图,图片宽高为750px*750px,宽高比1:1,800kb以内。支持jpg、jpeg、png格式的图片。
【示例值】https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original
image_list|商品子图必选string[](1000)
【描述】商品子图,作为平台详情页组件的轮播图,图片宽高为750px*750px,宽高比1:1,800kb以内,不超过 3 个图片。支持jpg、jpeg、png格式的图片。
【示例值】["https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original"]
path|商品详情页链接必选string(256)
【描述】商品详情页链接
【示例值】alipays://platformapi/startapp?appid=88888&page=test2
category_id|商品平台类目必选string(64)
【描述】平台类目,填写的类目必须在类目表列出,多级类目只填最后一级。商品类目 id 及信息可通过商品类目表获取。
【示例值】c001375074
price_unit|价格单元必选string(16)
【描述】商品价格单元
【枚举值】
元: 元
元/小时: 元/小时
元/日: 元/日
【示例值】元
spu_status|商品spu状态必选string(10)
【描述】审核驳回:商品审核失败时,商品状态为审核驳回。
审核中:商品处于审核流程中时,商品状态为审核中。
已下架:商家可以通过调用接口下架商品,也可以通过商家后台下架商品。
可售卖:商家可以通过调用接口上架商品,也可以通过商家后台上架商品。
冻结:当商家出现违规操作时,支付宝侧将发起冻结,商品无法对外透出。
当商品包含多个规格时,只要有一个规格的商品状态为“可售卖”,商品状态则为“可售卖”。
【枚举值】
审核驳回: audit_reject
审核中: auditing
已下架: delisting
【示例值】available
barcode|条形码必选string(64)
【描述】商品条形码
【示例值】01234567
create_time|创建时间必选date(20)
【描述】商品创建时间
【示例值】2023-01-01 00:00:00
update_time|更新时间必选date(20)
【描述】商品最新更新时间
【示例值】2023-01-01 00:00:00
skus|商品sku信息必选itemskusearchvo[]
【描述】商品sku信息
out_sku_id|商家侧sku id必选string(128)
【描述】商家侧sku id,要求 appid 下全局唯一。
【示例值】99999
sku_id|支付宝平台侧sku id必选string(64)
【描述】支付宝平台侧商品sku的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
【示例值】2023010123000000000001
sale_price|sku售价必选number(32)
【描述】sku售价,分为单位
【示例值】30
sku_attrs|sku销售属性必选itemskuattrvo[]
【描述】sku销售属性
attr_key|销售属性key必选string(30)
【描述】销售属性key值
【示例值】exmaple_key
attr_value|销售属性值必选string(50)
【描述】销售属性值
【示例值】example_value
attr_type|属性类型可选string(40)
【描述】属性的类型,选填,不填时默认赋值spec
【枚举值】
自定义属性: custom
规格: spec
【示例值】custom
thumb_img|sku小图可选string(256)
【描述】图片url,图片宽高为400px*400px,宽高比1:1。
【示例值】https://mdgwdev.alipay.net/mrch_material/afts/img/a*wjvvrz9174eaaaaaaaaaaaaaav91aq/original
original_price|sku原价可选number(32)
【描述】sku原价,分为单位
【示例值】120
sale_status|sku售卖状态可选string(16)
【描述】sku售卖状态,包含以下两种状态: 已下架(delisting) 可售卖(available)
【枚举值】
出售中: available
已下架: delisting
【示例值】available
stock_num|sku库存可选number(6)
【描述】sku库存,目前支持库存区间为0-99999
【示例值】9999
barcode|sku条形码可选string(64)
【描述】sku条形码
【示例值】12345678
price_unit|价格单位可选string(32)
【描述】sku价格单位
【示例值】元
sku_type|sku类型可选string(20)
【描述】sku类型
【枚举值】
售卖sku: sale
租赁sku: rent
【示例值】sale
scene_risk_info|场景问题描述必选itemsceneriskinfo[]
【描述】商品在对应场景屏蔽,展示对应的具体问题
scene|场景名称必选string(64)
【描述】场景名称
【示例值】直播
scene_code|场景编码必选string(64)
【描述】场景编码
【示例值】live
risk_infos|问题描述可选reasons[]
【描述】具体问题描述
risk_name|风险项名称可选string(128)
【描述】描述商品问题的类别,例如“商品页面”、“商品标题”...
【示例值】商品页面
remark|备注原因可选string(2048)
【描述】描述风险项对应的具体问题
【示例值】1.商品页面打不开;2.商品页面加载慢
problem_pic|示例图片可选string[](2048)
【描述】标识商品具体问题的图片
【示例值】["http://mdn.alipay.object.com/xxxxx.jpg"]
sale_price|商品售价条件必选number(32)
【描述】商品售价,分为单位。
【必选条件】若填写了skus[]数组,此字段不返回值
【示例值】100
stock_num|库存条件必选number(10)
【描述】目前支持库存区间0~99999
【必选条件】若填写了skus[]数组,此字段不用填写。
若未填写skus[]数组,此字段必填。
【示例值】100
direct_path|商品直接购买链接可选string(100)
【描述】商品直接购买链接
【示例值】alipays://platformapi/startapp?appid=88888&page=test
original_price|商品原价可选number(32)
【描述】商品原价,分为单位。若填写了skus[]数组,此字段不返回值
【示例值】200
risk_info|问题描述可选itemriskinfo[]
【描述】商品有冻结、驳回时,展示对应的具体问题
audit_time|审核时间可选date(25)
【描述】该商品最近一次审核完结时间
【示例值】2023-01-01 00:00:00
risk_infos|问题描述可选reasons
【描述】具体问题描述
risk_name|风险项名称可选string(128)
【描述】描述商品问题的类别,例如“商品页面”、“商品标题”...
【示例值】商品页面
remark|备注原因可选string(2048)
【描述】描述风险项对应的具体问题
【示例值】1.商品页面打不开;2.商品页面加载慢
problem_pic|示例图片可选string[](2048)
【描述】标识商品具体问题的图片
【示例值】["http://mdn.alipay.object.com/xxxxx.jpg"]
desc_info|商品详情信息可选itemdescinfovo
【描述】商品详情信息
imgs|商品详情描述图片可选string[](512)
【描述】商品详情描述图片(最多10张),图片宽为750px,高度小于3000px。若接入商品详情页组件且未完成自定义改动,则会将在详情页组件处透出。
【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【示例值】["a*phfasaesf_0aaaaaaaaaaaaaatcnaq"]
desc|商品详情描述文本可选string(2000)
【描述】商品详情描述文本(不超过2000字)。若接入商品详情页组件,将在详情页组件处透出。
【示例值】desc
attrs|商品属性可选appitemattrvo[]
【描述】商品属性列表,kv形式
attr_key|商品属性key必选string(40)
【描述】商品属性key
【示例值】key1
attr_value|商品属性value必选string(102400)
【描述】商品属性value
【示例值】value1
item_details_page_model|c端详情页模式可选string(10)
【描述】1=官方插件版,商品详情页链接不传入 0=自定义详情页版,商品详情页链接必须传入
【枚举值】
官方插件版: 1
自定义详情页版: 0
【示例值】1
auto_marketing_delivery|自动推广可选boolean(10)
【描述】透出商品是否自动推广:自动推广:true;不自动推广:false
【示例值】true
item_enroll_freeze_content|报名活动状态及文案可选itemenrollfreezecontent
【描述】报名活动状态及文案
item_enroll_flag|是否投放招商可选boolean(10)
【描述】是否投放招商
【示例值】true
in_live|是否参与直播秒杀可选boolean(10)
【描述】是否参与直播秒杀
【示例值】true
tips_and_urls|报名提示信息与跳转链接可选tipsandurl[]
【描述】提示信息&跳转链接
tips|提示文案可选string(500)
【描述】跳转链接的提示语
【示例值】查看报名活动
url|跳转链接可选string(10240)
【描述】跳转链接
【示例值】https://b.alipay.com/page/olive/s/batch-polymerize-enrolled?managetabtype=app_item¤t=1&pagesize=10
no_edit_key_list|不允许编辑字段列表可选string[](1000)
【描述】不允许编辑字段列表
【枚举值】
规格不可修改: sku_attrs
状态不可修改: sale_status
商品售价不可修改: sale_price
【示例值】["sku_attrs","sale_price"]
no_edit_tip_list|不允许编辑对外文案可选string[](1000)
【描述】用于对外透出文案
【示例值】["该商品已参与直播秒杀活动,商品价格及规格将无法修改。如需修改可前往直播秒杀活动中先终止活动"]
响应示例
正常示例
异常示例
{
"alipay_open_app_item_query_response": {
"code": "10000",
"msg": "success",
"is_online": false,
"out_item_id": "12345",
"item_id": "2023010122000000000001",
"title": "美味甜甜圈",
"desc": "导购标题1",
"head_img": "https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original",
"image_list": [
"https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original"
],
"path": "alipays://platformapi/startapp?appid=88888&page=test2",
"direct_path": "alipays://platformapi/startapp?appid=88888&page=test",
"category_id": "c001375074",
"price_unit": "元",
"sale_price": 100,
"original_price": 200,
"stock_num": 100,
"spu_status": "available",
"barcode": "01234567",
"risk_info": [
{
"audit_time": "2023-01-01 00:00:00",
"risk_infos": {
"risk_name": "商品页面",
"remark": "1.商品页面打不开;2.商品页面加载慢",
"problem_pic": [
"http://mdn.alipay.object.com/xxxxx.jpg"
]
}
}
],
"desc_info": {
"imgs": [
"a*phfasaesf_0aaaaaaaaaaaaaatcnaq"
],
"desc": "desc"
},
"create_time": "2023-01-01 00:00:00",
"update_time": "2023-01-01 00:00:00",
"skus": [
{
"out_sku_id": "99999",
"sku_id": "2023010123000000000001",
"thumb_img": "https://mdgwdev.alipay.net/mrch_material/afts/img/a*wjvvrz9174eaaaaaaaaaaaaaav91aq/original",
"sale_price": 30,
"original_price": 120,
"sale_status": "available",
"stock_num": 9999,
"barcode": "12345678",
"sku_attrs": [
{
"attr_key": "exmaple_key",
"attr_value": "example_value",
"attr_type": "custom"
}
],
"price_unit": "元",
"sku_type": "sale"
}
],
"attrs": [
{
"attr_key": "key1",
"attr_value": "value1"
}
],
"item_details_page_model": "1",
"scene_risk_info": [
{
"scene": "直播",
"scene_code": "live",
"risk_infos": [
{
"risk_name": "商品页面",
"remark": "1.商品页面打不开;2.商品页面加载慢",
"problem_pic": [
"http://mdn.alipay.object.com/xxxxx.jpg"
]
}
]
}
],
"auto_marketing_delivery": true,
"item_enroll_freeze_content": {
"item_enroll_flag": true,
"in_live": true,
"tips_and_urls": [
{
"tips": "查看报名活动",
"url": "https://b.alipay.com/page/olive/s/batch-polymerize-enrolled?managetabtype=app_item¤t=1&pagesize=10"
}
],
"no_edit_key_list": [
"sku_attrs",
"sale_price"
],
"no_edit_tip_list": [
"该商品已参与直播秒杀活动,商品价格及规格将无法修改。如需修改可前往直播秒杀活动中先终止活动"
]
}
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
cat_id_null | 参数有误类目id不能为空 | 请传入可用的类目id |
item_null | 商品不存在 | 商品不存在,请检查商家侧/平台侧商品id参数 |
permission_check_error | 权限校验失败 | 确认当前请求账号是否匹配当前传入pid或alipay_app_id,或已做相关授权 |