接口描述:

  • 添加一个商品。

请求 URL:

  • http|https://host/api/v1/goods/method/add.goods.item/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
goods_category_id integer gt:0 1 商品分类编号
name string max:200 MateBook 商品名称
short_name string max:50 MateBook 商品短名称
product_name string max:100 XXX促销 商品促销名
goods_code string max:50 CS*** CS91785258 商品货号
goods_spu string max:50 123456 商品SPU
goods_sku string max:50 654321 商品SKU
bar_code string max:60 123456 商品条码
brand_id integer egt:0 1 商品品牌编号
store_qty integer egt:0 100 商品库存
market_price number gt:0 7000 商品市场价
shop_price number gt:0 5400 商品本店价
integral_type integer in:0,1 0 赠送积分结算方式
give_integral number 见备注 0 540 商品赠送积分
is_integral integer egt:0 0 1000 积分可抵扣额
least_sum integer egt:0 0 1 最少起订量
purchase_sum integer egt:0 0 2 限购数量
keywords string max:255 华为 商品关键词
description string max:255 笔记本 商品描述
content string min:0 详情页 商品详情描述
attachment array min:1 ["//image_1.jpg"] 商品相册(至少一张主图)
video string max:255 //video.mp4 商品短视频
unit string max:10 商品计量单位
is_recommend integer in:0,1 0 1 是否推荐 0=不推 1=推荐
is_new integer in:0,1 0 1 是否新品 0=不新 1=新品
is_hot integer in:0,1 0 1 是否热卖 0=普通 1=热卖
goods_type_id integer gt:0 1 商品模型编号
sort integer between:0,255 50 50 排序值
status integer in:0,1 1 1 上下架状态 0=下架 1=上架
goods_attr_item array min[]:0 附属 A 商品属性列表
goods_spec_item array min[]:0 附属 B 商品规格列表
spec_image array min[]:0 附属 C 商品规格图
is_postage integer in:0,1 0 1 是否包邮 0=收费 1=包邮
measure number egt:0 0 3 商品计量(重量、体积)
measure_type integer in:0,1,2 0 0 计量方式 0=重量 1=计件 2=体积
附属 A: 类型 是否必须 范围值 默认值 示例值 描述
goods_attribute_id integer gt:0 1 商品属性编号
parent_id integer egt:0 0 商品属性主体
is_important integer in:0,1 1 是否核心属性 0=普通 1=核心
attr_value string max:150 I5 I7 属性值
sort integer max:150 50 50 排序值

示例 A:

  1. [
  2. {
  3. "goods_attribute_id": 1,
  4. "parent_id": 0,
  5. "is_important": 1,
  6. "attr_value": "I5 I7",
  7. "sort": 50
  8. },
  9. {
  10. "goods_attribute_id": 2,
  11. "parent_id": 0,
  12. "is_important": 1,
  13. "attr_value": "8G 16G",
  14. "sort": 50
  15. }
  16. ]
附属 B: 类型 是否必须 范围值 默认值 示例值 描述
key_name string max:100 1_3 商品规格键名
key_value string max:60 颜色:黑色 CPU:I5 商品规格值
price number gt:0 5400 商品价格
store_qty integer egt:0 100 商品库存
bar_code string max:60 商品条码
goods_sku string max:50 商品SKU

示例 B:

  1. [
  2. {
  3. "key_name": "1_3",
  4. "key_value": "颜色:黑色 CPU:I5",
  5. "price": 5400,
  6. "store_qty": 100
  7. },
  8. {
  9. "key_name": "1_4",
  10. "key_value": "颜色:黑色 CPU:I7",
  11. "price": 5900,
  12. "store_qty": 100
  13. }
  14. ]
附属 C: 类型 是否必须 范围值 默认值 示例值 描述
spec_item_id integer gt:0 1 商品规格项编号
image string max:255 //image_1.jpg 商品规格图片

示例 C:

  1. [
  2. {
  3. "spec_item_id": "1",
  4. "image": "//image_1.jpg"
  5. },
  6. {
  7. "spec_item_id": "2",
  8. "image": "//image_2.jpg"
  9. }
  10. ]

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
goods_category_id integer 1 商品分类编号
name string MateBook 商品名称
short_name string MateBook 商品短名称
product_name string XXX促销 商品促销名
goods_code string CS91785250 商品货号
goods_spu string 123456 商品SPU
goods_sku string 654321 商品SKU
bar_code string 123456 商品条码
brand_id integer 1 商品品牌编号
store_qty integer 200 商品库存
market_price number 7000 商品市场价
shop_price number 5400 商品本店价
integral_type integer 0 赠送积分结算方式
give_integral number 540 商品赠送积分
is_integral integer 1000 积分可抵扣额
least_sum integer 1 最少起订量
purchase_sum integer 2 限购数量
keywords string 华为 商品关键词
description string 笔记本 商品描述
content string 详情页 商品详情描述
attachment array ["//image_1.jpg"] 商品相册
video string //video.mp4 商品短视频
unit string 商品计量单位
is_recommend integer 1 是否推荐 0=不推 1=推荐
is_new integer 1 是否新品 0=不新 1=新品
is_hot integer 1 是否热卖 0=普通 1=热卖
goods_type_id integer 1 商品模型编号
sort integer 50 排序值
status integer 1 上下架状态 0=下架 1=上架
goods_attr_item array [] 商品属性列表数组
goods_spec_item array [] 商品规格列表数组
spec_image array [] 商品规格图数组
is_postage integer 1 是否包邮 0=收费 1=包邮
measure number 3 商品计量(重量、体积)
measure_type integer 0 计量方式 0=重量 1=计件 2=体积
create_time datetime 2018-05-23 00:25:09 创建时间
update_time datetime 2018-05-23 00:25:09 更新时间
goods_id integer 5 商品编号
goods_attr_item 类型 是否返回 示例值 描述
goods_attribute_id integer 1 商品属性编号
parent_id integer 0 商品属性主体
is_important integer 1 是否核心属性 0=普通 1=核心
attr_value string I5 I7 属性值
sort integer 50 排序值
goods_spec_item 类型 是否返回 示例值 描述
key_name string 1_3 商品规格键名
key_value string 颜色:黑色 CPU:I5 商品规格值
price number 5400 商品价格
store_qty integer 100 商品库存
bar_code string 123456 商品条码
goods_sku string 654321 商品SKU
spec_image 类型 是否返回 示例值 描述
spec_item_id integer 1 商品规格项编号
image string //image_1.jpg 商品规格图片

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "goods_category_id": 1,
  6. "name": "MateBook",
  7. "short_name": "MateBook",
  8. "product_name": "XXX促销",
  9. "goods_code": "CS91785250",
  10. "goods_spu": "123456",
  11. "goods_sku": "654321",
  12. "bar_code": "123456",
  13. "brand_id": 1,
  14. "store_qty": 200,
  15. "market_price": 7000,
  16. "shop_price": 5400,
  17. "integral_type": 0,
  18. "give_integral": 540,
  19. "is_integral": 1000,
  20. "least_sum": 1,
  21. "purchase_sum": 2,
  22. "keywords": "华为",
  23. "description": "笔记本",
  24. "content": "详情页",
  25. "attachment": [
  26. "//image_1.jpg"
  27. ],
  28. "video": "//video.mp4",
  29. "unit": "件",
  30. "is_recommend": 1,
  31. "is_new": 1,
  32. "is_hot": 1,
  33. "goods_type_id": 1,
  34. "sort": 50,
  35. "status": 1,
  36. "goods_attr_item": [
  37. {
  38. "goods_attribute_id": 1,
  39. "parent_id": 0,
  40. "is_important": 1,
  41. "attr_value": "I5 I7"
  42. },
  43. {
  44. "goods_attribute_id": 2,
  45. "parent_id": 0,
  46. "is_important": 1,
  47. "attr_value": "8G 16G"
  48. }
  49. ],
  50. "goods_spec_item": [
  51. {
  52. "key_name": "1_3",
  53. "key_value": "颜色:黑色 CPU:I5",
  54. "price": 5400,
  55. "store_qty": 100
  56. },
  57. {
  58. "key_name": "1_4",
  59. "key_value": "颜色:黑色 CPU:I7",
  60. "price": 5900,
  61. "store_qty": 100
  62. }
  63. ],
  64. "spec_image": [
  65. {
  66. "spec_item_id": 1,
  67. "image": "//image_1.jpg"
  68. },
  69. {
  70. "spec_item_id": 2,
  71. "image": "//image_2.jpg"
  72. }
  73. ],
  74. "is_postage": 1,
  75. "measure": 3,
  76. "measure_type": 0,
  77. "create_time": "2018-05-23 00:25:09",
  78. "update_time": "2018-05-23 00:25:09",
  79. "goods_id": 5
  80. }
  81. }

备注:

  1. 不传入goods_code参数,则系统自动生成一个。

  2. 当存在规格的情况下store_qty实际的数量由规格总和库存(系统自动计算)决定。

  3. 积分的换算比例由配置参数决定,具体参见「设置购物系统」

  4. 参数give_integral可设置的值范围由integral_type决定,当值为0时表示按实际支付金额百分比赠送,此时值的范围是0 ~ 100,当值为1时表示按固定值赠送,此时的值必须大于等于 0

  5. goods_spec_item参数中的key_namekey_value需要前端参与计算笛卡尔积后提交。key_name采用下划线_进行间隔。

  6. attachment参数中的第一位默认为商品的主图(或封面)。具体可上传几张图未做限制,由前端控制。

文档更新时间: 2018-06-22 22:10