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

公共请求参数

参数类型是否必选最大长度描述示例值
app_idstring必选32
支付宝分配给开发者的应用id
2014072300007148
methodstring必选128
接口名称
alipay.open.app.localitem.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|商家侧商品idstring[0,100]
【描述】商家侧商品id。与支付平台侧商品id不能同时为空,如果都提供,优先使用商家侧商品id。
【示例值】12345
item_id|支付宝侧商品idstring[1,64]
【描述】支付平台侧商品id。与商家侧商品id不能同时为空,如果都提供,优先使用商家侧商品id
【示例值】12345
need_edit_spu|是否查询编辑版本可选string[1,6]
【描述】是否查询编辑版本。默认为0
【枚举值】
查询在线版本: 0
查询编辑版本: 1
【示例值】0
常见请求示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.localitem.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":"12345",
	"item_id":"12345",
	"need_edit_spu":"0"
}' 
说明:本示例仅供参考。

公共响应参数

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

业务响应参数

category_id|商品平台类目必选string(64)
【描述】类目id
【注意事项】平台类目,填写的类目必须在类目表列出,多级类目只填最后一级。商品类目 id 及信息可通过商品类目表获取。
【示例值】111111
item_type|商品模版类型必选string(16)
【描述】商品模版类型: 1. 团购 2. 代金券 3. 次卡 4. 日历房
【枚举值】
团购套餐: 1
代金券: 2
次卡: 3
【示例值】1
out_item_id|商家侧商品id必选string(100)
【描述】商家侧商品id,要求 appid 下全局唯一。
【示例值】123456
item_id|支付宝平台侧商品id必选string(64)
【描述】支付宝平台侧商品id,是支付宝平台侧商品的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
【示例值】1000
is_online|是否线上版本必选boolean(6)
【描述】商品是否在线版本,true在线,false最新版本
【示例值】false
title|商品名称必选string(60)
【描述】商品名称,字符类型,最少不低于3,最长不超过60个字。注:1.商品标题只允许汉字、数字、英文字母、特殊字符集;2.商品标题不得仅为数字、字母、特殊字符集或上述三种的组合。
【示例值】代金券
merchant_name|商家名称必选string(60)
【描述】商家名称
【示例值】merchant_name
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[](128)
【描述】商品子图,作为平台详情页组件的轮播图,图片宽高为750px*750px,宽高比1:1,800kb以内,不超过 3 个图片。支持jpg、jpeg、png格式的图片。
【示例值】["https://mdn.alipayobjects.com/openpt_appstore/afts/img/a*phfasaesf_0aaaaaaaaaaaaaatcnaq/original"]
path|商品详情页链接必选string(512)
【描述】商品详情页链接
【示例值】alipays://platformapi/startapp?appid=88888&page=test2
item_details_page_model|c端详情页模式必选string(10)
【描述】1=官方插件版,商品详情页链接不传入 0=自定义详情页版,商品详情页链接必须传入
【枚举值】
官方插件版: 1
自定义详情页版: 0
【示例值】1
spu_status|商品spu状态必选string(32)
【描述】审核驳回:商品审核失败时,商品状态为审核驳回。 审核中:商品处于审核流程中时,商品状态为审核中。 已下架:商家可以通过调用接口下架商品,也可以通过商家后台下架商品。 可售卖:商家可以通过调用接口上架商品,也可以通过商家后台上架商品。 冻结:当商家出现违规操作时,支付宝侧将发起冻结,商品无法对外透出。 当商品包含多个规格时,只要有一个规格的商品状态为“可售卖”,商品状态则为“可售卖”。
【枚举值】
审核驳回: audit_reject
审核中: auditing
已下架: delisting
【示例值】available
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://*****
create_time|创建时间必选date(20)
【描述】商品创建时间
【示例值】2023-01-01 00:00:00
update_time|更新时间必选date(20)
【描述】商品最新更新时间
【示例值】2023-01-01 00:00:00
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"]
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
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"]
spu_id|标品id必选string(32)
【描述】标品id
【注意事项】查询日历房商品(item_type=7)时,返回关联的 spu id;查询团购、代金商品时(item_type=1或者2)不返回
【示例值】1
stock_num|商品库存可选string(10)
【描述】库存
【示例值】9999
attrs|商品属性可选appitemattrvo[]
【描述】商品属性
attr_key|商品属性key必选string(40)
【描述】商品属性key
【示例值】key1
attr_value|商品属性value必选string(102400)
【描述】商品属性value
【示例值】value1
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_localitem_query_response": {
        "code": "10000",
        "msg": "success",
        "category_id": "111111",
        "item_type": "1",
        "out_item_id": "123456",
        "item_id": "1000",
        "is_online": false,
        "title": "代金券",
        "merchant_name": "merchant_name",
        "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",
        "item_details_page_model": "1",
        "stock_num": "9999",
        "spu_status": "available",
        "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://*****"
        },
        "create_time": "2023-01-01 00:00:00",
        "update_time": "2023-01-01 00:00:00",
        "attrs": [
            {
                "attr_key": "key1",
                "attr_value": "value1"
            }
        ],
        "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"
                    ]
                }
            }
        ],
        "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"
            }
        ],
        "scene_risk_info": [
            {
                "scene": "直播",
                "scene_code": "live",
                "risk_infos": [
                    {
                        "risk_name": "商品页面",
                        "remark": "1.商品页面打不开;2.商品页面加载慢",
                        "problem_pic": [
                            "http://mdn.alipay.object.com/xxxxx.jpg"
                        ]
                    }
                ]
            }
        ],
        "spu_id": "1",
        "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参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
permission_check_error权限校验失败
确认当前请求账号是否匹配当前传入pid或alipay_app_id,或已做相关授权
service_not_exist服务不存在
重新创建
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
为开发者能享受更简单的协议处理逻辑、更丰富的开源工具配套、更低的接口响应时延,支付宝开放平台推出符合oas3.0规范的,助力开发体验。新版本文档请点击“查看v3版本”进行访问。
网站地图