小程序本地商品创建接口 -凯发app官方网站

支付

私域

小程序产品

权限集列表

搜索关键词

搜索直达

消息

小程序码

小程序服务

订单中心

小程序开发管理

生物核身

交易组件

小程序商品

接入指南

api 列表

普通商品

本地生活商品

商品管理

凭证管理

酒店日历房

租房

支付宝文件

商品变更相关

商品营销相关

接口说明

接口英文名称：alipay.open.app.localitem.create

请求url：https://openapi.alipay.com/v3/alipay/open/app/localitem/create

请求方式：post

path指该参数为路径参数

query指该参数需在请求url传参

body指该参数需在请求json传参

通用场景

创建小程序本地商品

公共请求参数

参数	类型	是否必选	最大长度	描述	示例值
authorization	string	必选	1024	请求身份信息，参考。在header参数中传递
content-type	string	可选	32	报文内容格式，默认需要使用application/json，加密请求使用text/plain，参考。在header参数中传递	application/json
x-http-method-override	string	可选	16	http方法，对于部分不支持put、patch、delete等操作的情况，可以使用post发送请求，并通过该参数传输实际需要使用的http method，参考。在header参数中传递	put
alipay-request-id	string	可选	32	调用方的requestid，用于定位一次请求，需要每次请求保持唯一。排查问题时可以提供该字段，参考。在header参数中传递。	0ba7cddb1665744697169391253118
alipay-encrypt-type	string	可选	16	加密算法，请求使用加密能力时，需要指定加密算法，参考。在header参数中传递	aes
alipay-root-cert-sn	string	可选	128	支付宝根证书序列号。证书模式时，可传入该参数，支付宝服务端会校验序列号，确保调用方的证书未被篡改，参考。在header参数中传递	687b59193f3f462dd5336e5abf83c5d8_02941eef3187dddf3d3b83462e1dfcf6
alipay-app-auth-token	string	可选	128	应用授权令牌，参考代调用规则。在header参数中传递	201509bbeff9351ad1874306903e96b91d248a36

业务请求参数

body参数

category_id｜类目id必选string(16)

【描述】商品类目id，可通过alipay.open.app.localitem.allcategory.query接口获取

【注意事项】仅叶子类目支持商品创建

【示例值】c000001234

item_type｜商品模版类型必选string(2)

【描述】商品模版类型：1. 团购 2. 代金券 3. 日历房

【枚举值】

团购: 1

代金券: 2

日历房: 7

【示例值】1

out_item_id｜商家侧商品id必选string(100)

【描述】商家侧商品id，要求 appid 下全局唯一

【示例值】12345678

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://*****

skus｜sku列表必选localitemskucreatevo[]

【描述】sku数组

sale_price｜sku售价必选number(32)

【描述】sku售价，分为单位

【示例值】100

original_price｜sku原价必选number(32)

【描述】sku原价，分为单位。

【示例值】100

sale_status｜售卖状态必选string(16)

【描述】sku售卖状态

【枚举值】

已下架: delisting

可售卖: available

【示例值】available

out_sku_id｜商家侧skuid可选string(64)

【描述】商家侧自定义的app下唯一的skuid

【示例值】weweqweq

stock_num｜sku库存可选number(32)

【描述】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)

【描述】图片afts文件id，可以通过 alipay.marketing.image.enhance.upload 获取图片文件id

【示例值】a*v4ozq5dsezsaaaaaaaaaaaaadnh5aq

attrs｜属性列表必选appitemattrvo[]

【描述】商品属性，通过alipay.open.app.localitem.template.query获取本地商品模板信息接口得到商品属性key，is_required=1时属性必填

【注意事项】属性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

sold_time｜售卖时间条件必选timerangestructvo

【描述】start_time描述售卖开始时间，end_time描述售卖结束时间，时间格式均为yyyy-mm-dd hh:mm:ss

【注意事项】可用开始时间必须晚于售卖开始时间，可用结束时间必须晚于售卖结束时间

【必选条件】当传入item_type != 9（日历房）时必选

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

image_list｜商品图片的文件id列表可选string[](1000)

【描述】商品子图，作为平台详情页组件的轮播图，图片宽高为750px*750px，宽高比1:1，800kb以内，不超过 3 个图片。支持jpg、jpeg、png格式的图片。

【注意事项】可以通过 alipay.marketing.image.enhance.upload 获取图片文件id

【示例值】["a*phfasaesf_0aaaaaaaaaaaaaatcnaq"]

merchant_name｜商家名称可选string(60)

【描述】商家名称

【示例值】merchant_name

auto_marketing_delivery｜自动推广可选boolean(10)

【描述】商品提报，如果需要自动推广则传此参数true，如没有这需求传false

【示例值】true

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
类目id	category_id	string	必选	16	商品类目id，可通过alipay.open.app.localitem.allcategory.query接口获取注意事项仅叶子类目支持商品创建	c000001234
商品模版类型	item_type	string	必选	2	商品模版类型：1. 团购 2. 代金券 3. 日历房枚举值团购: 1 代金券: 2 日历房: 7	1
商家侧商品id	out_item_id	string	必选	100	商家侧商品id，要求 appid 下全局唯一	12345678
标品id	spu_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
商品图片的文件id列表	image_list	string[]	可选	1000	商品子图，作为平台详情页组件的轮播图，图片宽高为750px*750px，宽高比1:1，800kb以内，不超过 3 个图片。支持jpg、jpeg、png格式的图片。注意事项可以通过 alipay.marketing.image.enhance.upload 获取图片文件id	["a*phfasaesf_0aaaaaaaaaaaaaatcnaq"]
c端详情页模式	item_details_page_model	string	必选	10	1=官方插件版，商品详情页链接不传入 0=自定义详情页版，商品详情页链接必须传入枚举值官方插件版: 1 自定义详情页版: 0	1
商品详情页url	path	string	条件必选	512	商品详情页url 必选条件当c端详细页模式item_details_page_model为0（自定义详情页版）时，该字段必填	alipays://platformapi/startapp?appid=88888&page=test
售卖时间	sold_time	timerangestructvo	条件必选		start_time描述售卖开始时间，end_time描述售卖结束时间，时间格式均为yyyy-mm-dd hh:mm:ss 注意事项可用开始时间必须晚于售卖开始时间，可用结束时间必须晚于售卖结束时间必选条件当传入item_type != 9（日历房）时必选
商家名称	merchant_name	string	可选	60	商家名称	merchant_name
客服电话	customer_service_mobile	phonestructvo	必选		客服电话，包含区号电话号码的座机号码格式，以及手机号码格式
sku列表	skus	localitemskucreatevo[]	必选		sku数组
属性列表	attrs	appitemattrvo[]	必选		商品属性，通过alipay.open.app.localitem.template.query获取本地商品模板信息接口得到商品属性key，is_required=1时属性必填注意事项属性key对应的属性值可以查看
自动推广	auto_marketing_delivery	boolean	可选	10	商品提报，如果需要自动推广则传此参数true，如没有这需求传false	true

常见请求示例

推荐示例

默认示例

curljavac#php

curl -x post \
 "https://openapi.alipay.com/v3/alipay/open/app/localitem/create" \
 -h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
 -h "alipay-request-id: ${requestid}" \
 -h "alipay-app-auth-token: ${app_auth_token}" \
 -h "content-type: application/json" \
 -d '{
	"attrs":[
		{
			"attr_key":"key1",
			"attr_value":"1"
		}
	],
	"category_id":"c000001234",
	"customer_service_mobile":{
		"phone_number":"156xxxxxx12",
		"phone_type":"1"
	},
	"head_img":"a*phfasaesf_0aaaaaaaaaaaaaatcnaq",
	"image_list":[
		"***",
		"***"
	],
	"item_details_page_model":"1",
	"item_type":"1",
	"merchant_name":"merchant_name",
	"out_item_id":"12345678",
	"skus":[
		{
			"original_price":100,
			"sale_price":100,
			"sale_status":"available",
			"stock_num":9999
		}
	],
	"sold_time":{
		"end_time":"2023-01-01 10:00:00",
		"start_time":"2023-01-01 10:00:00"
	},
	"title":"product_name"
}'

说明：本示例仅供参考。

公共响应参数

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
支付宝响应时间戳	alipay-timestamp	string	可选	32	unix时间戳，用于验签及问题排查，参考。在header参数中传递	1666004496123
支付宝响应签名	alipay-signature	string	可选	512	支付宝响应报文签名，参考。在header中返回
支付宝traceid	alipay-traceid	string	可选	64	支付宝traceid ，用于排查问题使用，参考。在header中返回	0ba7cddb1665744697169391253118
支付宝随机串	alipay-nonce	string	可选	64	支付宝nonce标记，每次请求会生成不同的nonce，可用于防重放判断，参考。在header中返回	515cf24c2f78b13564e94c2a495695ab

业务响应参数

item_id｜支付宝平台侧商品id必选string(64)

【描述】支付宝平台侧商品id，是支付宝平台侧商品的唯一标识，后续与平台交互，需要使用该 id，建议持久化。

【示例值】2023010122000000000001

out_item_id｜商家侧商品id可选string(100)

【描述】商家侧商品id，要求 appid 下全局唯一.

【示例值】12345

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

参数	类型	是否必选	最大长度	描述	示例值
out_item_id	string	可选	100	商家侧商品id，要求 appid 下全局唯一.	12345
item_id	string	必选	64	支付宝平台侧商品id，是支付宝平台侧商品的唯一标识，后续与平台交互，需要使用该 id，建议持久化。	2023010122000000000001
skus	itemskuidpair[]	可选		sku数组

响应示例

正常示例

异常示例

{
	"out_item_id":"12345",
	"item_id":"2023010122000000000001",
	"skus":[
		{
			"sku_id":"2023010123000000000001",
			"out_sku_id":"99999"
		}
	]
}

说明：本示例仅供参考。

公共错误码

业务错误码

状态码	错误码	错误描述	凯发app官方网站的解决方案
400	system_error	系统繁忙	服务器异常可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
400	invalid_parameter	参数有误	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试
400	cat_id_null	参数有误类目id不能为空	请传入可用的类目id
400	cat_license_no_permission	类目未开通	商户类目未开通，请前往支付宝商家后台（b.alipay.com）-运营中心-商品管理-商品类目-去管理开通对应的类目
400	cat_not_access	类目不准入	请检查是商品类型/子类型是否有权限创建本地商品
400	item_already_exist	商品已经存在	请确认商品信息
400	item_attr_rule_check_error	属性规则校验不通过	请检查提交的属性字段是否正确
400	item_category_not_auth	未授权企信，该类目不准入	该类目不准入，不支持商品创建。可在支付宝商家平台（服务商请到服务商平台）-小程序-商品管理-类目管理中查看并申请类目
400	item_category_not_exist	已授权企信，该类目不准入	该类目不准入，不支持商品创建。可在支付宝商家平台（服务商请到服务商平台）-小程序-商品管理-类目管理中查看并申请类目
400	item_cat_not_exist	类目不存在	请检查类目id是否正确
400	item_settle_account_check_fail	账号校验失败	请确认商品收款账号是否配置、与当前主体是否关联正确
400	item_shop_check_fail	本地商品门店校验失败	请输入正确的门店id
400	item_template_not_exist	商品模板不存在	检查类目是否配置商品模板
400	mini_app_has_not_reg	小程序未完成备案	您好，当前小程序未完成备案，请前往备案完成后，再将小程序商品同步到支付宝
400	mini_app_not_online	小程序未上架	请先上架当前小程序
400	permission_check_error	权限校验失败	确认当前请求账号是否匹配当前传入pid或alipay_app_id，或已做相关授权
400	spu_not_exist	根据spuid找不到对应的spu信息	请从spu创建接口获取正确的spuid返回值

设置阅读模式

接口说明

公共请求参数

业务请求参数

公共响应参数

业务响应参数

公共错误码

业务错误码

相关问题