开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
支付产品
私域产品
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
小程序服务
订单中心
小程序开发管理
生物核身
交易组件
小程序商品
接入指南
普通商品接入指南
本地生活商品接入指南
api 列表
相关资料
支付有礼
商家粉丝群
营销产品
资金产品
会员产品
信用产品
广告产品
已更新
文档更新记录 >
收藏
订阅更新
我的文档
设置
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
完成 接入准备 后,商家和服务商可根据本文指引快速集成 小程序商品
说明:
小程序商品 仅支持自研商家/服务商通过 自研应用第三方应用 代调用(传入 app_auth_token)方式,调用 api 接入。
小程序商品 支持沙箱调试。
本地生活商品接入

本地商品类目列表查询接口
商家可通过alipay.open.app.localitem.allcategory.query(获取本地商品类目接口)获取支付宝小程序当前支持的所有本地商品类目信息,商家可以根据自己小程序的资质情况选择合适的类目进行商品提报。

注意
不同商品类型返回的类目信息可能不一样。
本地商品模板查询接口
商家可通过 alipay.open.app.localitem.template.query(获取本地商品模板信息接口)获取不同类目下需要添加的个性化属性信息,接口里面的类目 id 编码是从类目列表查询接口中获取到的。

注意
不同类目以及不同商品类型,对应的个性化属性及其校验规则是不一样的,这个地方需要动态实时查询。
创建本地商品接口
商家可通过 alipay.open.app.localitem.create(小程序本地商品创建接口)向支付宝提报小程序内的商品详情页url。创建成功后支付宝会返回支付宝平台侧商品id作为该商品的支付宝全局唯一商品编码供后续使用。

注意
需保证商品的商家侧商品编码在该小程序下的唯一性。
商品创建接口里面的属性列表字段需要和该类目模板查询接口里面的属性列表字段对齐,所有的必填属性都需要存在,非必填属性可以不用填写。
本地商品详情查询接口
商家可通过 alipay.open.app.localitem.query(小程序本地商品详情查询接口)查询已同步到支付宝侧的商品数据详情,由于商品是多版本的,对于商家而言,可以根据接口中的参数控制查询当前生效版的商品详情数据,还是最新的编辑态待审核的商品数据。

注意
商品查询需要传入创建时返回的支付宝侧商品id,或者商家侧商品id,两者不可同时为空。
商品创建完成后通过审核,所以首次提交的商品在审核结果未出前,需要设置 need_edit_spu=1 才能查询到。
本地商品列表查询接口
商家可通过 alipay.open.app.localitem.list.query(小程序本地商品分页查询接口)查询已同步到支付宝侧的商品数据。

注意
商品查询需要传入创建时返回的平台侧商品id列表,或者商家侧id列表,两者不可同时为空,不可以混传。
该接口只能查询生效中的商品详情,不能根据不同的 id 返回不同版本的数据。
本地商品更新接口
商家可通过 alipay.open.app.localitem.modify(小程序本地商品修改接口)修改支付宝侧的商品数据。

注意
商品首先需要同步到支付宝侧后才能支持修改,如果商品已经有一个版本是在审核中了,这时候商品是不支持修改的。
本地商品免审更新接口
正常情况下修改商品详情页的基础字段等信息都需要进行审核。为了方便商家及时的修改库存、状态等信息,商家可通过 alipay.open.app.localitem.direct.modify(小程序本地商品免审更新商品接口) 使用平台侧商品编码修改商品以及sku售卖状态、商品sku库存、价格(sku售价)。

注意
商品首先需要同步到支付宝侧后才能支持状态修改,审核中的商品不支持修改。
删除本地商品接口
商家可通过 alipay.open.app.item.delete(小程序商品移除接口) ,通过上传商家侧商品id列表,或是返回的支付宝平台侧商品id删除不需要的商品信息。

注意
商品首先需要同步到支付宝侧后才能支持删除。
商品删除会同时将生效中的版本和审核中的版本全部删除并从场景侧下线,并且删除是不可逆的,谨慎操作。
商品状态变更消息通知接口
商家/服务商可以监听 alipay.open.app.item.status.notify(商品状态变更消息同步接口),感知商品状态信息的变更。商品审核通过或驳回,以及后续商品售罄或冻结(违规/质量异常)均会通过本消息进行通知。
注意
1商品状态变更通知会在商品状态变更时发出,包括审核、售罄、冻结等操作生效之后发出。
2变更推广计划通知仅包含简单的推广计划变更通知信息,更多商品信息需通过 alipay.open.app.localitem.query(小程序本地商品详情查询接口) 获取。
消息示例:
营销图片优化上传接口
商家可以调用 alipay.marketing.image.enhance.upload(营销图片优化上传接口),指定上传场景对商品图进行规范校验、智能优化后再上传,将图片信息转存到支付宝侧进行使用,比如商品主子图等。
image.png

凭证管理接入
平台券码
接入步骤

凭证核销准备
平台码需要先调用核销准备接口,获取订单包含的凭证信息,选择要核销的凭证,再调用核销接口核销凭证。商家券码不需要调用此接口,直接进行凭证核销。
商家根据扫码或输码信息调用 alipay.marketing.certificate.certification.prepareuse(凭证核销准备接口)进行核销准备,接口同步返回订单包含的凭证加密券码信息。
接口入参的 encrypted_data和 code 必须且只能二选一。
扫码核销:通过扫描二维码获取 encrypteddata 字段值,作为接口 encrypted_data 入参。二维码扫码结果示例:
输码核销:取二维码下方的 12 位券码作为接口 code 入参。
跳转小程序使用:跳转链接里会拼接 encrypteddata,从链接中获取 encrypteddata 字段值作为接口 encrypted_data 入参。链接示例:https://open.alipay.com/api?encrypteddata=1xx123456x12345678900xx1234x1234567
更多请求参数说明及错误码详情,参见 alipay.marketing.certificate.certification.prepareuse(凭证核销准备接口) 接口文档。
通过二维码解析标识获取加密券码
通过原始券码获取加密券码
凭证核销
商家可通过 alipay.marketing.certificate.certification.use(同步凭证核销状态接口)进行本地生活商品凭证核销,接口同步返回核销结果。商家需保证 out_biz_no(外部业务单号)唯一,用作幂等控制。
biz_dt:业务发生时间,支付宝核销时间以外部业务时间为准,防止极限情况不能核销,商家需保证业务时间的准确性。