编辑商品

更新时间:2024-01-12 02:42:47下载pdf

本文介绍编辑商品的 API。

接口描述

编辑店铺商品库中的商品,支持单个编辑。

接口地址

POST: /v1.0/cloud/ecm/store/admin/api/commodity/edit

请求参数

body 说明

参数名类型参数位置是否必填说明
mall_codeString true商城 Code。
site_codeString true站点 Code。
commodity_codeString true商品 Code,必传。
titleString false商品标题,最多 80 个字符。
sub_titleString false商品副标题,最多 250 个字符。
descriptionString false商品描述,支持富文本,最多 20000 个字符。
brandString false商品品牌,最多 30 个字符。
first_category_codeString false一级类目 Code。
second_category_codeString false二级类目 Code。
third_category_codeString false三级类目 Code。
showcase_codesList false前台类目 Code 列表。
videoString false商品展示视频。使用该接口时,要求传视频 URL,该 URL 支持通过浏览器打开视频文件。仅支持 MP4 格式,不超过 50M,建议时长 9-30 秒。
video_picString false视频展示图。使用该接口时,要求传图片 URL,该 URL 支持通过浏览器打开图片。当 video 参数值不为空时,本参数为必填参数。
show_picturesList false商品展示图片。使用该接口时,要求传图片 URL,该 URL 支持通过浏览器打开图片。最多支持 10 张图片,只支持 JPG、PNG 和 GIF 格式。文件尺寸小于等于 500 KB,建议尺寸 750 × 750 像素。
is_jumpBoolean false是否跳转第三方。
  • true:支持。
  • false:不支持,默认 false
jump_linkString false商品跳转链接。当 is_jumptrue,本参数为必填参数。
publishBoolean false商品是否上架。
  • true:立即上架商品,默认 true
  • false:商品不上架。
sku_listList falseSKU 列表,最多支持 100 组 SKU。

sku_list 说明

参数名类型参数位置是否必填说明
skuCodeString falseSKU Code,SKU 唯一编码。修改某个已存在的 SKU 时,本参数为必填参数。
skuPicListList falseSKU 图片列表。使用该接口时,要求传图片 URL,该 URL 支持通过浏览器打开。最多支持 10 张图片,只支持 JPG、PNG 和 GIF 格式。每张图片的尺寸小于等于 500 KB,建议尺寸 750 × 750 像素。
originalPriceBigDecimal falseSKU 原价,最多支持两位小数。不传默认为 0
salePriceBigDecimal falseSKU 售价,最多支持两位小数。不传默认为 0
inventoryInteger false库存,支持整数。不传默认为 0
weightBigDecimal false重量,最多支持三位小数,单位 KG。不传默认为 0
externalCodeString false外部编码。
supportOutStockBuyBoolean false是否支持零库存下单。
skuAttrListList falseSKU 属性集合。

skuAttrList 说明

参数名类型参数位置是否必填说明
attrCodeString true属性编码。
attrValueIdLong true属性值 ID。
attrNameString false属性名称。
attrValueNameString false属性值名称。

返回参数

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

result 说明

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

请求示例

POST: /v1.0/cloud/ecm/store/admin/api/commodity/edit
{
  "mall_code": "8h4tiureddm***",
  "site_code": "CN",
  "commodity_code": "CMaplyr4bzck***",
  "title": "冰箱",
  "sub_title": "Hr冰箱X0",
  "description": "<div><p>智能冰箱...</p><img src='https://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg' /></div>",
  "brand": "hr",
  "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": true,
  "jump_link": "www.demo.com/home",
  "publish": true,
  "sku_list": [
    {
      "skuCode": "SKba0j4xcti***",
      "skuPicList": [
        "https://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg"
      ],
      "externalCode": "",
      "inventory": 100,
      "originalPrice": 1,
      "salePrice": 2,
      "supportOutStockBuy": false,
      "skuAttrList": [
        {
          "attrCode": "ATci8mev9w0***",
          "attrName": "颜色",
          "attrValueId": 6181512,
          "attrValueName": "白色"
        }
      ],
      "weight": 0
    }
  ]
}

返回示例

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

错误码

参考 错误码

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