通用场景
修改小程序本地商品
公共请求参数
业务请求参数
category_id｜类目id必选string(16)
【描述】商品类目id，可通过alipay.open.app.localitem.allcategory.query接口获取
【注意事项】仅叶子类目支持商品创建
【示例值】c000001234
item_details_page_model｜c端详情页模式必选string(10)
【描述】1=官方插件版，商品详情页链接不传入 0=自定义详情页版，商品详情页链接必须传入
【枚举值】
官方插件版: 1
自定义详情页版: 0
【示例值】1
customer_service_mobile｜客服电话必选phonestructvo
【描述】客服电话，包含区号 电话号码的座机号码格式，以及手机号码格式
phone_type｜电话类型条件必选string(5)
【描述】电话类型
【枚举值】
手机号: 1
座机: 2
【必选条件】填写电话号码时需指定手机号或者座机号
【示例值】1
以下参数 二选一 传入必选
phone_number｜电话号码string(30)
【描述】电话号码，包含区号 电话号码的座机号码格式，以及手机号码格式
【注意事项】与客服链接至少填写一个
【示例值】156xxxxxx12
customer_link｜客服链接string(500)
【描述】客服链接地址，必须以alipays开头。用户点击链接后可直接进入客服页面进行咨询
【注意事项】与电话号码至少填写一个
【示例值】alipays://*****
attrs｜属性列表必选appitemattrvo[]
【描述】商品属性，通过alipay.open.app.localitem.template.query获取本地商品模板信息接口得到商品属性key
【注意事项】属性key对应的属性值可以参考本地生活商品模板文档：本地生活商品模版
attr_key｜商品属性key必选string(40)
【描述】商品属性key
【示例值】key1
attr_value｜商品属性value必选string(102400)
【描述】商品属性value
【示例值】value1
spu_id｜标品id条件必选string(64)
【描述】标品id
【必选条件】创建日历房商品（item_type=7）时，传入关联的 spu id，由保存spu接口alipay.open.app.localitem.spu.save返回；
创建团购、代金商品时（item_type=1或者2）时不传
【示例值】2023010122000000000001
title｜商品名称条件必选string(60)
【描述】商品名称，字符类型，最少不低于3，最长不超过60个字。注：1.商品名称只允许汉字、数字、英文字母、特殊字符集；2.商品名称不得仅为数字、字母、特殊字符集或上述三种的组合。
【必选条件】创建团购或代金券商品(item_type=1或2)时必传；创建日历房商品(item_type=7)时不传
【示例值】product_name
head_img｜商品主图条件必选string(128)
【描述】商品主图，图片宽高为750px*750px，宽高比1:1，800kb以内。支持jpg、jpeg、png格式的图片。
【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【必选条件】创建团购或代金券商品(item_type=1或2)时必传；创建日历房商品(item_type=7)时不传
【示例值】a*phfasaesf_0aaaaaaaaaaaaaatcnaq
path｜商品详情页url条件必选string(512)
【描述】商品详情页url
【必选条件】当c端详细页模式item_details_page_model为0（自定义详情页版）时，该字段必填
【示例值】alipays://platformapi/startapp?appid=88888&page=test
item_type｜商品模版类型可选string(2)
【描述】商品模版类型：1. 团购 2. 代金券 3. 次卡 4. 日历房
【枚举值】
团购: 1
代金券: 2
次卡: 3
【示例值】1
out_item_id｜商家侧商品id可选string(100)
【描述】商家侧商品id，要求 appid 下全局唯一
【示例值】12345678
item_id｜支付宝平台侧商品id可选string(64)
【描述】支付宝平台侧商品id，是支付宝平台侧商品的唯一标识，后续与平台交互，需要使用该 id，建议持久化。
【示例值】2023010122000000000001
image_list｜商品图片的文件id列表可选string[](1000)
【描述】商品子图，作为平台详情页组件的轮播图，图片宽高为750px*750px，宽高比1:1，800kb以内，不超过 3 个图片。支持jpg、jpeg、png格式的图片。
【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【示例值】["a*phfasaesf_0aaaaaaaaaaaaaatcnaq"]
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
merchant_name｜商家名称可选string(60)
【描述】商家名称
【示例值】merchant_name
skus｜sku数组可选localitemskumodifyvo[]
【描述】sku数组
sku_id｜平台侧skuid必选string(64)
【描述】支付宝平台侧商品sku的唯一标识
【示例值】2023010122000000000001
original_price｜sku原价必选number(32)
【描述】sku原价，分为单位。
【示例值】100
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
stock_num｜sku库存可选string(10)
【描述】sku库存
【示例值】9999
sku_attrs｜sku销售属性列表可选itemskuattrvo[]
【描述】sku销售属性列表
attr_key｜销售属性key必选string(30)
【描述】销售属性key值
【示例值】exmaple_key
attr_value｜销售属性值必选string(50)
【描述】销售属性值
【示例值】example_value
thumb_img_id｜sku子图文件id可选string(64)
【描述】sku图片的afts文件id，可以通过 alipay.marketing.image.enhance.upload 获取图片文件id
【示例值】a*v4ozq5dsezsaaaaaaaaaaaaadnh5aq
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.localitem.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={
"category_id":"c000001234",
"item_type":"1",
"out_item_id":"12345678",
"item_id":"2023010122000000000001",
"spu_id":"2023010122000000000001",
"title":"product_name",
"head_img":"a*phfasaesf_0aaaaaaaaaaaaaatcnaq",
"image_list":[
"a*phfasaesf_0aaaaaaaaaaaaaatcnaq"
],
"item_details_page_model":"1",
"path":"alipays://platformapi/startapp?appid=88888&page=test",
"sold_time":{
"start_time":"2023-01-01 10:00:00",
"end_time":"2023-01-01 10:00:00"
},
"merchant_name":"merchant_name",
"customer_service_mobile":{
"phone_type":"1",
"phone_number":"156xxxxxx12",
"customer_link":"alipays://*****"
},
"skus":[
{
"out_sku_id":"99999",
"original_price":100,
"stock_num":"9999",
"sale_status":"available",
"sku_id":"2023010122000000000001",
"thumb_img_id":"a*v4ozq5dsezsaaaaaaaaaaaaadnh5aq",
"sale_price":100,
"sku_attrs":[
{
"attr_key":"exmaple_key",
"attr_value":"example_value"
}
]
}
],
"attrs":[
{
"attr_key":"key1",
"attr_value":"value1"
}
]
}' 说明：本示例仅供参考。
公共响应参数
业务响应参数
out_item_id｜商家侧商品id必选string(100)
【描述】商家侧商品id，要求 appid 下全局唯一.
【示例值】12345
item_id｜支付宝平台侧商品id必选string(64)
【描述】支付宝平台侧商品id，是支付宝平台侧商品的唯一标识，后续与平台交互，需要使用该 id，建议持久化。
【示例值】2023010122000000000001
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_localitem_modify_response": {
"code": "10000",
"msg": "success",
"out_item_id": "12345",
"item_id": "2023010122000000000001",
"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 | 商品已经存在 | 请确认商品信息 |
| item_attr_rule_check_error | 属性规则校验不通过 | 请检查提交的属性字段是否正确 |
| item_cannot_op_when_activity | 商品在活动中不可修改 | 商品在活动中不可修改，请等待活动结束 |
| item_cannot_op_when_auditing | 商品在审核中不允许操作 | 商品在审核中不允许操作 |
| item_cat_not_exist | 类目不存在 | 请检查类目id是否正确 |
| item_null | 商品数据为空 | 未查询到生效中的商品数据 |
| item_settle_account_check_fail | 账号校验失败 | 请确认商品收款账号是否配置、与当前主体是否关联正确 |
| item_shop_check_fail | 本地商品门店校验失败 | 请输入正确的门店id |
| item_template_not_exist | 商品模板不存在 | 检查类目是否配置商品模板 |
| mini_app_not_online | 小程序未上架 | 请先上架当前小程序 |
| permission_check_error | 权限校验失败 | 确认当前请求账号是否匹配当前传入pid或alipay_app_id，或已做相关授权 |
| service_status_not_editable | 商品当前状态不可编辑 | 商品当前状态不可编辑，确定商品是否是在审核中或已移除 |
| spu_not_exist | 根据spuid找不到对应的spu信息 | 请从spu创建接口获取正确的spuid返回值 |