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

线上售卖商品

线上实物租赁

商品公域售卖（实物与虚拟）

api 列表

提报商品

商品查看与下单

商品支付与履约

商品退款

数据对账

使用插件

公共请求参数

参数	类型	是否必选	最大长度	描述	示例值
app_id	string	必选	32	支付宝分配给开发者的应用id	2014072300007148
method	string	必选	128	接口名称	alipay.open.app.item.create
format	string	可选	40	仅支持json	json
charset	string	必选	10	请求使用的编码格式，如utf-8,gbk,gb2312等	utf-8
sign_type	string	必选	10	商户生成签名字符串所使用的签名算法类型，目前支持rsa2和rsa，推荐使用rsa2	rsa2
sign	string	必选	344	商户请求参数的签名串，详见签名	详见示例
timestamp	string	必选	19	发送请求的时间，格式"yyyy-mm-dd hh:mm:ss"	2014-07-24 03:07:50
version	string	必选	3	调用的接口版本，固定为：1.0	1.0
app_auth_token	string	可选	40	详见应用授权概述
biz_content	string	必选		请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

业务请求参数

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

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

【示例值】12345

title｜商品名称必选string(100)

【描述】商品名称，字符类型，最少不低于3，最长不超过100个字。

【注意事项】1.商品标题只允许汉字、数字、英文字母、特殊字符集；2.商品标题不得仅为数字、字母、特殊字符集或上述三种的组合。

【示例值】product_name

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

item_type｜商品类型条件必选string(1)

【描述】商品类型；若类目涉及多个商品类型，则需传此参数，以调用准确的商品模板。

【枚举值】

售卖类（实物）: 1

租赁类（实物）: 2

付费充值/兑换类（虚拟）: 3

【必选条件】若类目涉及多个商品类型，则需传此参数，以调用准确的商品模板。

【示例值】2

path｜商品详情页url条件必选string(256)

【描述】商品详情页url

【必选条件】当传入item_details_page_model，且item_details_page_model = "0"时必填

【示例值】alipays://platformapi/startapp?appid=88888888&page=test

sale_price｜商品售价条件必选number(32)

【描述】商品售价，分为单位。

【必选条件】若未填写skus[]数组，此字段必填；若填写了skus[]数组，此字段不填写。如果填写，值必须要大于0。

【示例值】30

original_price｜商品原价条件必选number(32)

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

【必选条件】若未填写skus[]数组，此字段可选；若填写了skus[]数组，此字段不填写。如果填写，值必须大于0，且原价不能小于售价。

【示例值】30

sale_status｜商品售卖状态条件必选string(16)

【描述】商品的售卖状态

【枚举值】

可售卖: available

已下架: delisting

【必选条件】若填写了skus[]数组，此字段不用填写。若未填写skus[]数组，此字段必填。

【示例值】available

desc｜导购描述可选string(128)

【描述】导购描述，用于介绍商品卖点

【示例值】product_description

image_list｜商品子图可选string[](1000)

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

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

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

price_unit｜价格单元可选string(16)

【描述】价格单元

【枚举值】

元: 元

元/小时: 元/小时

元/日: 元/日

【示例值】元

stock_num｜库存可选number(10)

【描述】若填写了skus[]数组，此字段不用填写。若未填写skus[]数组，此字段选填。目前支持库存区间为0-99999999。

【示例值】9999

barcode｜商品条形码可选string(64)

【描述】条形码

【示例值】abcd1234

skus｜sku数组可选itemskucreatevo[]

【描述】sku数组，sku数量上限为50

out_sku_id｜商家侧sku id必选string(128)

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

【示例值】99999

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售价必选string(32)

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

【示例值】100

thumb_img｜sku小图可选string(256)

【描述】sku小图。图片宽高为400px*400px，宽高比1:1。

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

【示例值】a*phfasaesf_0aaaaaaaaaaaaaatcnaq

stock_num｜sku库存可选string(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

desc_info｜商品详情可选itemdescinfovo

【描述】商品描述详情

imgs｜商品详情描述图片可选string[](512)

【描述】商品详情描述图片（最多10张），图片宽为750px，高度小于3000px。若接入商品详情页组件且未完成自定义改动，则会将在详情页组件处透出。

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

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

desc｜商品详情描述文本可选string(2000)

【描述】商品详情描述文本（不超过2000字）。若接入商品详情页组件，将在详情页组件处透出。

【示例值】desc

attrs｜商品属性可选appitemattrvo[]

【描述】商品属性

【注意事项】属性key和value的说明可以参考普通商品属性介绍

attr_key｜商品属性key必选string(40)

【描述】商品属性key

【示例值】key1

attr_value｜商品属性value必选string(102400)

【描述】商品属性value

【示例值】value1

item_details_page_model｜c端详情页模式可选string(1)

【描述】1=官方插件版，商品详情页链接不传入 0=自定义详情页版，商品详情页链接必须传入

【枚举值】

官方插件版: 1

自定义详情页版: 0

【示例值】1

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

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

【示例值】true

参数	类型	是否必选	最大长度	描述	示例值
out_item_id	string	必选	100	商家侧商品id，要求 appid 下全局唯一。	12345
item_type	string	条件必选	1	商品类型；若类目涉及多个商品类型，则需传此参数，以调用准确的商品模板。枚举值售卖类（实物）: 1 租赁类（实物）: 2 付费充值/兑换类（虚拟）: 3 必选条件若类目涉及多个商品类型，则需传此参数，以调用准确的商品模板。	2
title	string	必选	100	商品名称，字符类型，最少不低于3，最长不超过100个字。注意事项 1.商品标题只允许汉字、数字、英文字母、特殊字符集；2.商品标题不得仅为数字、字母、特殊字符集或上述三种的组合。	product_name
desc	string	可选	128	导购描述，用于介绍商品卖点	product_description
head_img	string	必选	128	商品主图，图片宽高为750px*750px，宽高比1:1，800kb以内。支持jpg、jpeg、png格式的图片。注意事项可以通过 alipay.marketing.image.enhance.upload 获取图片文件id	a*phfasaesf_0aaaaaaaaaaaaaatcnaq
image_list	string[]	可选	1000	商品子图，作为平台详情页组件的轮播图，图片宽高为750px*750px，宽高比1:1，800kb以内，不超过 3 个图片。支持jpg、jpeg、png格式的图片。注意事项可以通过 alipay.marketing.image.enhance.upload 获取图片文件id	["a*phfasaesf_0aaaaaaaaaaaaaatcnaq"]
path	string	条件必选	256	商品详情页url 必选条件当传入item_details_page_model，且item_details_page_model = "0"时必填	alipays://platformapi/startapp?appid=88888888&page=test
category_id	string	必选	64	平台类目，填写的类目必须在类目表列出，多级类目只填最后一级。商品类目 id 及信息可通过获取。仅叶子类目支持创建商品。	c001375074
sale_price	number	条件必选	32	商品售价，分为单位。必选条件若未填写skus[]数组，此字段必填；若填写了skus[]数组，此字段不填写。如果填写，值必须要大于0。	30
original_price	number	条件必选	32	商品原价，分为单位。必选条件若未填写skus[]数组，此字段可选；若填写了skus[]数组，此字段不填写。如果填写，值必须大于0，且原价不能小于售价。	30
price_unit	string	可选	16	价格单元枚举值元: 元元/小时: 元/小时元/日: 元/日元/周: 元/周元/月: 元/月元/季: 元/季元/年: 元/年元/次: 元/次元/场: 元/场元/m2: 元/m2	元
stock_num	number	可选	10	若填写了skus[]数组，此字段不用填写。若未填写skus[]数组，此字段选填。目前支持库存区间为0-99999999。	9999
sale_status	string	条件必选	16	商品的售卖状态枚举值可售卖: available 已下架: delisting 必选条件若填写了skus[]数组，此字段不用填写。若未填写skus[]数组，此字段必填。	available
barcode	string	可选	64	条形码	abcd1234
skus	itemskucreatevo[]	可选		sku数组，sku数量上限为50
desc_info	itemdescinfovo	可选		商品描述详情
attrs	appitemattrvo[]	可选		商品属性注意事项属性key和value的说明可以参考普通商品属性介绍
item_details_page_model	string	可选	1	1=官方插件版，商品详情页链接不传入 0=自定义详情页版，商品详情页链接必须传入枚举值官方插件版: 1 自定义详情页版: 0	1
auto_marketing_delivery	boolean	可选	10	商品提报，如果需要自动推广则传此参数true，如没有这需求传false	true

常见请求示例

多规格商品创建

商品创建

默认示例

curljavac#php

curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.item.create&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":"c001375074",
	"desc":"product_name",
	"head_img":"a*phfasaesf_0aaaaaaaaaaaaaatcnaq",
	"out_item_id":"12345",
	"path":"alipays://platformapi/startapp?appid=88888&page=test",
	"sale_status":"available",
	"skus":[
		{
			"original_price":100,
			"out_sku_id":"99999",
			"sale_price":"100",
			"sale_status":"available",
			"sku_attrs":[
				{
					"attr_key":"颜色规格",
					"attr_value":"1100g"
				}
			],
			"stock_num":"9999",
			"thumb_img":"a*phfasaesf_0aaaaaaaaaaaaaatcnaq"
		},
		{
			"original_price":100,
			"out_sku_id":"99999",
			"sale_price":"100",
			"sale_status":"available",
			"sku_attrs":[
				{
					"attr_key":"颜色规格",
					"attr_value":"200g"
				}
			],
			"stock_num":"9999",
			"thumb_img":"a*phfasaesf_0aaaaaaaaaaaaaatcnaq"
		}
	],
	"title":"product_name"
}'

说明：本示例仅供参考。

公共响应参数

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

业务响应参数

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

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

响应示例

正常示例

异常示例

{
    "alipay_open_app_item_create_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	参数有误	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试
cat_id_null	参数有误类目id不能为空	请传入可用的类目id
cat_license_no_permission	类目未开通	商户类目未开通，请前往支付宝商家后台（b.alipay.com）-运营中心-商品管理-商品类目-去管理开通对应的类目
cat_not_access	类目不准入，当前类目暂未开放不支持商品创建	请检查确认类目数据
item_already_exist	商品已经存在	请确认商品信息
item_attr_rule_check_error	属性规则校验不通过	请检查提交的属性字段是否正确
item_category_not_auth	未授权企信，该类目不准入	该类目不准入，不支持商品创建。可在支付宝商家平台（服务商请到服务商平台）-小程序-商品管理-类目管理中查看并申请类目
item_category_not_exist	已授权企信，该类目不准入	该类目不准入，不支持商品创建。可在支付宝商家平台（服务商请到服务商平台）-小程序-商品管理-类目管理中查看并申请类目
item_cat_not_exist	商品类目不存在	商品类目不存在，请检查商品类目
mini_app_has_not_reg	小程序未完成备案	您好，当前小程序未完成备案，请前往备案完成后，再将小程序商品同步到支付宝
mini_app_not_online	小程序未上架	请先上架当前小程序
permission_check_error	权限校验失败	确认当前请求账号是否匹配当前传入pid或alipay_app_id，或已做相关授权
service_null	商品不存在	请确认商品信息
service_status_not_editable	商品当前状态不可编辑	商品当前状态不可编辑，确定商品是否是在审核中或已移除

公共请求参数

业务请求参数

公共响应参数

业务响应参数

公共错误码

业务错误码

相关问题