通用场景
用于更新小程序商品
公共请求参数
业务请求参数
title|商品名称必选string(60)
【描述】商品名称,字符类型,最少不低于3,最长不超过60个字。
【注意事项】1.商品标题只允许汉字、数字、英文字母、特殊字符集;2.商品标题不得仅为数字、字母、特殊字符集或上述三种的组合。
【示例值】美味甜甜圈
path|商品详情页地址必选string(256)
【描述】商品详情页地址
【示例值】alipays://platformapi/startapp?appid=88888888&page=test
head_img|商品主图必选string(128)
【描述】商品主图,图片宽高为750px*750px,宽高比1:1,800kb以内。支持jpg、jpeg、png格式的图片。
【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【示例值】a*phfasaesf_0aaaaaaaaaaaaaatcnaq
category_id|平台类目必选string(64)
【描述】平台类目,填写的类目必须在类目表列出,多级类目只填最后一级。商品类目 id 及信息可通过获取。仅叶子类目支持创建商品。
【示例值】c001375074
以下参数 二选一 传入必选
out_item_id|商家侧商品idstring(100)
【描述】商家侧商品id,要求 appid 下全局唯一。
【注意事项】如果同时out_item_id和item_id, 以item_id 为准。
【示例值】12345
item_id|支付宝平台侧商品idstring(64)
【描述】支付宝平台侧商品id,是支付宝平台侧商品的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
【示例值】2023010122000000000001
sale_price|商品售价条件必选number(32)
【描述】商品售价,分为单位。
【注意事项】如果填写,值必须要大于0。
【必选条件】若填写了skus[]数组,此字段不用填写。
若未填写skus[]数组,此字段必填。
【示例值】30
original_price|商品原价条件必选number(32)
【描述】商品原价,分为单位。
【注意事项】如果填写,值必须大于0,且原价不能小于售价。
【必选条件】若填写了skus[]数组,此字段不用填写。
若未填写skus[]数组,此字段必填。
【示例值】30
sale_status|商品售卖状态条件必选string(16)
【描述】商品的售卖状态
【枚举值】
可售卖: available
已下架: delisting
冻结: freeze
【必选条件】若填写了skus[]数组,此字段不用填写。
若未填写skus[]数组,此字段必填
【示例值】available
item_type|商品类型可选string(2)
【描述】商品类型,默认为实物商品
【枚举值】
售卖类(实物): 1
租赁类(实物): 2
付费充值/兑换类(虚拟): 3
【示例值】1
desc|导购描述可选string(128)
【描述】导购描述,用于介绍商品卖点
【示例值】美味可口
direct_path|商品立即购买链接可选string(256)
【描述】商品立即购买链接地址
【示例值】alipays://platformapi/startapp?appid=88888&page=test2
image_list|商品子图可选string[](1000)
【描述】商品子图,作为平台详情页组件的轮播图,图片宽高为750px*750px,宽高比1:1,800kb以内,不超过 3 个图片。支持jpg、jpeg、png格式的图片。
【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【示例值】["a*phfasaesf_0aaaaaaaaaaaaaatcnaq"]
desc_info|商品详情信息可选itemdescinfovo
【描述】商品详情信息
imgs|商品详情描述图片可选string[](512)
【描述】商品详情描述图片(最多10张),图片宽为750px,高度小于3000px。若接入商品详情页组件且未完成自定义改动,则会将在详情页组件处透出。
【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【示例值】["a*phfasaesf_0aaaaaaaaaaaaaatcnaq"]
desc|商品详情描述文本可选string(2000)
【描述】商品详情描述文本(不超过2000字)。若接入商品详情页组件,将在详情页组件处透出。
【示例值】desc
price_unit|价格单元可选string(16)
【描述】价格单元
【枚举值】
元: 元
元/小时: 元/小时
元/日: 元/日
【示例值】元
stock_num|库存可选number(100)
【描述】若填写了skus[]数组,此字段不用填写。 若未填写skus[]数组,此字段选填。目前支持库存区间为0-99999999。
【示例值】9999
skus|sku数组可选itemskuvo[]
【描述】sku数组
sale_status|售卖状态必选string(16)
【描述】sku售卖状态,包含以下两种状态:
已下架(delisting)
可售卖(available)
【示例值】available
sku_attrs|商品销售属性必选itemskuattrvo[]
【描述】销售属性列表
attr_key|销售属性key必选string(30)
【描述】销售属性key值
【示例值】exmaple_key
attr_value|销售属性值必选string(50)
【描述】销售属性值
【示例值】example_value
attr_type|属性类型可选string(40)
【描述】属性的类型,选填,不填时默认赋值spec
【枚举值】
自定义属性: custom
规格: spec
【示例值】custom
sale_price|sku售价必选number(32)
【描述】sku售价,分为单位
【示例值】100
以下参数 二选一 传入必选
out_sku_id|商家侧sku idstring(128)
【描述】商家侧sku id,要求 appid 下全局唯一。
【示例值】99999
sku_id|支付宝平台侧sku idstring(64)
【描述】支付宝平台侧商品sku的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
【示例值】2023010123000000000001
thumb_img|sku小图可选string(256)
【描述】sku小图。图片宽高为400px*400px,宽高比1:1。
【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【示例值】a*phfasaesf_0aaaaaaaaaaaaaatcnaq
stock_num|sku库存可选number(6)
【描述】sku库存,目前支持库存区间为0-99999
【示例值】9999
barcode|条形码可选string(64)
【描述】sku条形码信息
【示例值】12345678
original_price|sku原价可选number(32)
【描述】sku原价,分为单位。
【示例值】100
price_unit|价格单元可选string(16)
【描述】商品价格单元
【示例值】元
sku_type|sku类型可选string(20)
【描述】sku类型
【枚举值】
售卖sku: sale
租赁sku: rent
【示例值】sale
barcode|条形码可选string(64)
【描述】条形码
【示例值】01234567
attrs|商品属性可选appitemattrvo[]
【描述】商品属性
【注意事项】属性key和value的说明可以参考普通商品属性介绍
attr_key|商品属性key必选string(40)
【描述】商品属性key
【示例值】key1
attr_value|商品属性value必选string(102400)
【描述】商品属性value
【示例值】value1
常见请求示例
推荐示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.item.modify&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={
"title":"美味甜甜圈",
"path":"alipays://platformapi/startapp?appid=88888&page=test",
"head_img":"a*phfasaesf_0aaaaaaaaaaaaaatcnaq",
"category_id":"c001375074"
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
out_item_id|支付宝平台侧商品id必选string(100)
【描述】商家侧spu商品 id,要求 appid 下全局唯一.
【示例值】8888888
item_id|商家侧商品id必选string(64)
【描述】支付宝平台侧spu id,是支付宝平台侧商品的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
【示例值】99999999
skus|sku数组可选itemskuidpair[]
【描述】sku数组
sku_id|支付宝平台侧sku id必选string(64)
【描述】支付宝平台侧商品sku的唯一标识,后续与平台交互,需要使用该 id,建议持久化。
【示例值】2023010123000000000001
out_sku_id|商家侧sku id必选string(100)
【描述】商家侧sku id,appid 下全局唯一。
【注意事项】如果是普通商品,该字段值由创建、更新接口传入;
如果是本地生活商品,该字段值由系统自动设置,保持和out_item_id一致
【示例值】99999
响应示例
正常示例
异常示例
{
"alipay_open_app_item_modify_response": {
"code": "10000",
"msg": "success",
"out_item_id": "8888888",
"item_id": "99999999",
"skus": [
{
"sku_id": "2023010123000000000001",
"out_sku_id": "99999"
}
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
can_not_valid_when_punish | 商品处于冻结状态,不可操作 | 商品解冻后重试 |
cat_id_null | 参数有误类目id不能为空 | 参数有误类目id不能为空 |
cat_license_no_permission | 类目未开通 | 商户类目未开通,请前往支付宝商家后台(b.alipay.com)-运营中心-商品管理-商品类目-去管理开通对应的类目 |
cat_not_access | 类目不准入,当前类目暂未开放不支持商品创建 | 请检查确认类目数据 |
item_already_exist | outitemid发生变化,当前appid下已存在相同的outitemid的商品 | 请修改outitemid |
item_attr_rule_check_error | 属性规则校验不通过 | 请检查提交的属性字段是否正确 |
item_cannot_op_during_activity | 已参加直播间秒杀活动,无法编辑任何信息 | 如需修改,请先停止直播间秒杀活动 |
item_cannot_op_when_activity | 商品在活动中不可修改 | 商品在活动中不可修改,请等待活动结束 |
item_cannot_op_when_auditing | 商品在审核中,不允许操作 | 等待商品审核完成后再操作 |
item_category_not_auth | 未授权企信,该类目不准入 | 该类目不准入,不支持商品创建。可在支付宝商家平台(服务商请到服务商平台)-小程序-商品管理-类目管理中查看并申请类目 |
item_cat_not_exist | 商品类目不存在 | 商品类目不存在,请检查商品类目 |
item_null | 商品不存在 | 商品不存在,请检查商家侧/平台侧商品id参数 |
mini_app_not_online | 小程序未上架 | 请先上架当前小程序 |
permission_check_error | 权限校验失败 | 确认当前请求账号是否匹配当前传入pid或alipay_app_id,或已做相关授权 |
service_status_not_editable | 商品当前状态不可编辑 | 商品当前状态不可编辑,确定商品是否是在审核中或已移除 |