云服务 API 参考行业场景垂直行业解决方案App Mall开放能力商品管理添加商品

添加商品

更新时间：2024-01-12 02:37:04下载pdf

本文介绍添加商品的 API。

接口描述

将商品添加到店铺的商品库，支持单个添加。

接口地址

POST: /v1.0/sellercenter/commodity

请求参数

body 说明

参数名	类型	是否必填	说明
mall_code	String	true	商城编码。
site_code	String	true	国家码。
type	Integer	false	商品类型。 `0`：实体商品。 `5`：虚拟商品。
title	String	true	商品标题，最多 80 个字符。
description	String	false	商品描述。商品详情信息可维护到该字段，支持 RTF 文本格式，最多 20000 个字符。
brand	String	false	商品品牌，最多 30 个字符。
code	String	false	商品编码或者型号，最多 50 个字符。
pid	String	false	商品 PID，最多 16 个字符。该字段已废弃。
first_category_code	String	false	一级类目编码。
second_category_code	String	false	二级类目编码。
third_category_code	String	false	三级类目编码。
showcase_codes	List	false	前台类目编码列表。
video	String	false	商品展示视频。使用该接口时，要求传视频 URL，该 URL 支持通过浏览器打开视频文件。仅支持 MP4 格式，不超过 50M，建议时长 9-30 秒。
video_pic	String	false	视频展示图。使用该接口时，要求传图片 URL，该 URL 支持通过浏览器打开。当 `video` 不为空时，该参数为必要参数。
show_pictures	List	false	商品展示图片。使用该接口时，要求传图片 URL，该 URL 支持通过浏览器打开。最多支持 10 张图片，只支持 JPG、PNG 和 GIF 格式。每张图片的尺寸小于等于 500 KB，建议尺寸 750 × 750 像素。
detail_pictures	List	false	商品详情图片，已废弃。使用该接口时，要求传图片 URL，该 URL 支持通过浏览器打开。最多支持 15 张图片，只支持 JPG、PNG 和 GIF 格式。每张图片的尺寸小于等于 3 MB，建议尺寸 750 × 750 像素。
sku_list	List	false	SKU 列表，最多支持 100 组 SKU。
postage_type	Integer	false	邮费类型，已废弃。 `1`：免邮费。 `2`：统一邮费。
postage_fee	BigDecimal	false	商品邮费，已废弃。如果 `postageType` 为 `2`，则该字段必填。
install_type	Integer	false	安装类型，已废弃。 `1`：无需安装，默认值。 `2`：上门安装。 `3`：安装自理。
install_fee	BigDecimal	false	安装费用，已废弃。
is_jump	Boolean	false	是否跳转第三方。 `true`：支持。 `false`：不支持。默认值。
jump_link	String	false	商品跳转链接。如果 `isJump` 为 `true`, 则此字段为必填。
publish	Boolean	false	商品是否上架。 `true`：立即上架。默认值。 `false`：商品不上架。
sub_title	String	false	商品副标题，最多 250 个字符。
multiple_options	Boolean	false	是否多规格 SKU。 `true`：多规格。 `false`：单规格。

sku_list 说明

参数名	类型	是否必填	说明
sku_pic_list	List	false	SKU 图片列表。使用该接口时，要求传图片 URL，该 URL 支持通过浏览器打开。最多支持 10 张图片，只支持 JPG、PNG 和 GIF 格式。每张图片的尺寸小于等于 500 KB，建议尺寸 750 × 750 像素。
original_price	BigDecimal	false	SKU 原价，最多支持两位小数。不传默认为0
sale_price	BigDecimal	false	SKU 售价，最多支持两位小数。不传默认为0
inventory	Integer	false	库存，支持整数。不传默认为0
weight	BigDecimal	false	重量，最多支持三位小数，单位 KG。不传默认为0
external_code	String	false	外部编码。
support_out_stock_buy	Boolean	false	是否支持零库存下单。
sku_attr_list	List	false	SKU 属性集合。

sku_attr_list 说明

参数名	类型	是否必填	说明
attr_code	String	true	属性编码。
attr_value_id	Long	true	属性值 ID。
attr_name	String	false	属性名称
attr_value_name	String	false	属性值名称

返回参数

参数名	类型	说明
result	CommodityAddOpenApiVO	返回结果。

result 说明

参数名	类型	说明
commodity_code	String	商品唯一编码。

请求示例

POST: /v1.0/sellercenter/commodity

{
  "mall_code": "8h4tiureddm***",
  "site_code": "CN",
  "type": 0,
  "title": "冰箱",
  "sub_title": "Hr冰箱X0",
  "description": "<div><p>智能冰箱...</p><img src='https://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg' /></div>",
  "brand": "hr",
  "code": "define_code",
  "first_category_code": "12",
  "second_category_code": "1312",
  "third_category_code": "131211",
  "show_pictures": [
    "https://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg"
  ],
  "video": "https://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.mp4",
  "video_pic": "https://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg",
  "showcase_codes": [
    "Cbgrc6mvk***"
  ],
  "is_jump": false,
  "jump_link": "",
  "multiple_options": true,
  "publish": true,
  "sku_list": [
    {
      "sku_pic_list": [
        "https://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg"
      ],
      "external_code": "",
      "inventory": 100,
      "original_price": 1,
      "sale_price": 2,
      "support_out_stock_buy": false,
      "sku_attr_list": [
        {
          "attr_code": "COLOR",
          "attr_value_id": 1001
        }
      ],
      "weight": 0
    }
  ]
}

返回示例

{
    "result": {
        "commodity_code": "CMaplyr4bzck***"
    },
    "t": 1624969838836,
    "success": true
}

错误码

参考错误码。

错误码	错误信息	说明
2000000	params error	参数错误
2001000	shop does not exist	店铺（站点）不存在
2000001	character limit exceeded	超出字符限制
2002002	commodity title already exists	商品标题已存在
2002003	category does not exist	商品类目不存在
2002004	failed to add commodity	商品添加失败
2002201	sku exceeds the maximum limit	SKU 数量超出最大限制
2002202	sku attribute does not exist	SKU 属性不存在
2002203	the sku combination rule is wrong	SKU 未按照规则组合
2004000	image size exceeds limit	媒体文件大小超出限制
2004001	the number of pictures exceeds the limit	图片数量超出限制
2004002	picture error	图片有误
2004003	video error	视频文件有误

上一篇商品管理

下一篇获取 SKU 支持关联的属性