接口描述:

  • 获取管理后台商品列表。

请求 URL:

  • http|https://host/api/v1/goods/method/get.goods.admin.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
goods_id array egt[]:0 [1,2,3] 商品编号
exclude_id array gt[]:0 [4,5,6] 商品排除Id
goods_category_id integer gt:0 1 商品分类编号
keywords string max:200 笔记本 商品关键词搜索
goods_code string max:60 CS*** 商品code、spu、sku、bar编码
brand_id integer egt:0 1 商品品牌编号
store_qty array length:2 [0,10] 商品库存
is_postage integer in:0,1 1 是否包邮 0=收费 1=包邮
is_integral integer in:0,1 1 是否可积分抵扣 0=否 1=是
is_recommend integer in:0,1 1 是否推荐 0=不推 1=推荐
is_new integer in:0,1 1 是否新品 0=不新 1=新品
is_hot integer in:0,1 1 是否热卖 0=普通 1=热卖
status integer in:0,1 1 上下架状态 0=下架 1=上架
is_delete integer in:0,1 0 1 回收站商品 0=否 1=是
is_goods_spec integer in:0,1 0 1 是否返回规格 0=否 1=是
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc desc asc 排序方式
order_field string 见附属 A goods_id store_qty 排序字段

附属 A:
in:goods_id,goods_code,name,shop_price,store_qty,is_integral,is_recommend,is_new,is_hot

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 4 合计计数
items 类型 是否返回 示例值 描述
goods_id integer 5 商品编号
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 商品库存
comment_sum integer 0 评价数量
sales_sum integer 0 销售数量
measure number 3 商品计量(重量、体积)
measure_type integer 0 计量方式 0=重量 1=计件 2=体积
is_postage integer 1 是否包邮 0=收费 1=包邮
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=上架
is_delete integer 0 商品状态 0=正常 1=回收
create_time datetime 2018-05-23 00:25:09 创建时间
update_time datetime 2018-05-23 00:25:09 更新时间
goods_spec_item array [] 商品规格列表数组
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

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "goods_id": 13,
  8. "goods_category_id": 1,
  9. "name": "MateBook",
  10. "short_name": "MateBook",
  11. "product_name": "XXX促销",
  12. "goods_code": "CS38491916",
  13. "goods_spu": "123456",
  14. "goods_sku": "654321",
  15. "bar_code": "123456",
  16. "brand_id": 1,
  17. "store_qty": 200,
  18. "comment_sum": 0,
  19. "sales_sum": 0,
  20. "measure": 3,
  21. "measure_type": 0,
  22. "is_postage": 1,
  23. "market_price": 7000,
  24. "shop_price": 5400,
  25. "integral_type": 0,
  26. "give_integral": 540,
  27. "is_integral": 1000,
  28. "least_sum": 1,
  29. "purchase_sum": 2,
  30. "keywords": "华为",
  31. "description": "笔记本",
  32. "content": "详情页",
  33. "attachment": [
  34. "//image_1.jpg"
  35. ],
  36. "video": "//video.mp4",
  37. "unit": "件",
  38. "is_recommend": 1,
  39. "is_new": 1,
  40. "is_hot": 1,
  41. "goods_type_id": 1,
  42. "sort": 50,
  43. "status": 1,
  44. "is_delete": 0,
  45. "create_time": "2018-05-23 14:35:41",
  46. "update_time": "2018-05-23 14:35:41",
  47. "goods_spec_item": [
  48. {
  49. "key_name": "1_3",
  50. "key_value": "颜色:黑色 CPU:I5",
  51. "price": 5400,
  52. "store_qty": 100,
  53. "bar_code": "",
  54. "goods_sku": ""
  55. },
  56. {
  57. "key_name": "1_4",
  58. "key_value": "颜色:黑色 CPU:I7",
  59. "price": 5900,
  60. "store_qty": 100,
  61. "bar_code": "",
  62. "goods_sku": ""
  63. }
  64. ]
  65. },
  66. {
  67. "goods_id": 4,
  68. "goods_category_id": 1,
  69. "name": "不带规格的商品",
  70. "short_name": "",
  71. "product_name": "",
  72. "goods_code": "CS99427315",
  73. "goods_spu": "",
  74. "goods_sku": "",
  75. "bar_code": "",
  76. "brand_id": 0,
  77. "store_qty": 0,
  78. "comment_sum": 0,
  79. "sales_sum": 0,
  80. "measure": 0,
  81. "measure_type": 0,
  82. "is_postage": 1,
  83. "market_price": 500,
  84. "shop_price": 300,
  85. "integral_type": 0,
  86. "give_integral": 0,
  87. "is_integral": 0,
  88. "least_sum": 0,
  89. "purchase_sum": 0,
  90. "keywords": "",
  91. "description": "",
  92. "content": "商品详情页",
  93. "attachment": [
  94. "//image.jpg"
  95. ],
  96. "video": "",
  97. "unit": "",
  98. "is_recommend": 0,
  99. "is_new": 0,
  100. "is_hot": 0,
  101. "goods_type_id": 1,
  102. "sort": 50,
  103. "status": 1,
  104. "is_delete": 0,
  105. "create_time": "2018-05-22 00:48:30",
  106. "update_time": "2018-05-22 00:48:30",
  107. "goods_spec_item": []
  108. }
  109. ],
  110. "total_result": 4
  111. }
  112. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。

  2. 参数keywords支持多个关键词,但只支持空格间隔。如需更高级搜索支持,请自行部署全文索引

  3. 参数store_qty采用区间查询,使用数组第一位表示起始库存,第二位表示结束库存。

  4. 参数is_delete值为1时,参数status将无效。

文档更新时间: 2018-08-21 17:41