商品服务（goods）-商品基本信息管理（外部）

添加商品（餐饮应用使用-按角色）

基本信息

Path： /goods/goods/createGoodsByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
ref_id	string	非必须		电子菜谱ID
goods_name	string	必须		商品名称
image_details	object []	非必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
goods_price	number	必须		商品价格
gc_id	string	必须		商品分类
goods_advword	string	非必须
goods_discount	number	非必须		商品折扣
goods_desc	string	非必须		商品描述
extend_info	string	非必须		扩展信息
store_id	string	必须		店铺ID
goods_storage_check	integer	非必须		是否验证库存：0验证 1不验证
packing_fee	number	必须		包装费
need_matching	integer	必须		1：需要撮合，0：无需，默认是0
tomorrow_storage	integer	必须		默认库存

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

添加商品（餐饮应用使用）

基本信息

Path： /goods/goods/createGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
ref_id	string	非必须		电子菜谱ID
goods_name	string	必须		商品名称
image_details	object []	非必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
goods_price	number	必须		商品价格
gc_id	string	必须		商品分类
goods_advword	string	非必须
goods_discount	number	非必须		商品折扣
goods_desc	string	非必须		商品描述
extend_info	string	非必须		扩展信息
goods_storage_check	integer	非必须		是否验证库存：0验证 1不验证
need_matching	string	必须		1：需要撮合，0：无需，默认是0
tomorrow_storage	string	必须		默认库存

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

添加商品

基本信息

Path： /goods/goods/addGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
is_virtual	integer	非必须			format: int32
store_id	string	必须		店铺id
goods_name	string	必须		商品名称
goods_price	number	必须		商品价格
gc_id	string	必须		商品分类
goods_storage	integer	必须		总库存	format: int32
storegc_ids	string []	非必须		商品分组ID数组	item 类型: string
├─		非必须
goods_advword	string	非必须		商品关键字
goods_id	string	非必须
goods_desc	string	非必须		商品描述
goods_marketprice	number	必须		商品市场价
need_matching	string	必须		1：需要撮合，0：无需，默认是0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

添加商品套餐

基本信息

Path： /goods/goods/createGoodsPkg

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	非必须		商品ID
goods_name	string	必须		商品名称
goods_advword	string	非必须		商品关键字
goods_desc	string	非必须		商品描述
gc_id	string	必须		商品分类
discount_amount	number	必须		优惠金额
packing_fee	number	必须		包装费
extend_info	string	非必须		扩展信息JSON
image_details	object []	必须		商品图片组合	item 类型: object
├─ imagePath	string	必须		商品图片路径
├─ sort	integer	必须		商品图片排序
├─ isDefault	integer	必须		商品图片默认主图，1是，0否
├─ fileType	integer	必须		文件类型：1图片2视频
pkg_group	object []	必须			item 类型: object
├─ group_name	string	必须		商品分组
├─ goods_num	integer	必须		商品数量
├─ goods_list	string []	必须		商品列表	item 类型: string
├─		非必须
├─ group_index	integer	非必须		组内排序
has_role	boolean	非必须		默认false
store_id	string	非必须
need_matching	integer	必须		是否需要撮合，1：需要，0：不需要

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码
data	object	必须		响应数据
id	string	必须		商品ID

删除商品（按角色）

基本信息

Path： /goods/goods/deleteByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除商品

基本信息

Path： /goods/goods/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

批量删除商品

基本信息

Path： /goods/goods/batchDelete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_ids	string []	必须		商品ID数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新某条商品信息

基本信息

Path： /goods/goods/updateGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_name	string	必须		商品名称
goods_price	number	必须		商品价格
goods_storage	integer	必须		商品库存	format: int32
storegc_ids	string []	非必须		商品分组ID数组	item 类型: string
├─		非必须
goods_advword	string	非必须
goods_id	string	必须		商品ID
goods_desc	string	非必须		商品描述
goods_marketprice	number	必须		商品市场价
need_matching	string	必须		1：需要撮合，0：无需，默认是0
tomorrow_storage	string	必须		明天默认库存

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新某条商品信息（餐饮应用使用-按角色）

基本信息

Path： /goods/goods/updateGoodsInfoByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_name	string	必须		商品名称
goods_price	number	必须		商品价格
goods_advword	string	非必须
goods_discount	number	非必须		商品折扣
goods_id	string	必须		商品ID
goods_desc	string	非必须		商品描述
extend_info	string	非必须		扩展信息
need_matching	string	必须		1：需要撮合，0：无需，默认是0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新某条商品信息（餐饮应用使用）

基本信息

Path： /goods/goods/updateGoodsInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_name	string	必须		商品名称
goods_price	number	必须		商品价格
goods_advword	string	非必须
goods_discount	number	非必须		商品折扣
goods_id	string	必须		商品ID
goods_desc	string	非必须		商品描述
extend_info	string	非必须		扩展信息
need_matching	string	必须		1：需要撮合，0：无需，默认是0
goods_storage_check	integer	必须		是否检验库存 是否验证库存：0验证 1不验证

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

获取一条商品信息

基本信息

Path： /goods/goods/getGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ is_virtual	integer	必须		是否为虚拟商品 1:是 0:否	format: int32
├─ type_name	string	必须		商品类型名称
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		商品分类ID
├─ goods_storage	integer	必须		总库存	format: int32
├─ evaluation_count	integer	必须		评价数	format: int64
├─ goods_costprice	number	必须		商品成本价
├─ price_min	number	必须		最低价
├─ extend_info	string	必须		扩展信息
├─ goods_salenum	integer	必须		销量	format: int64
├─ goods_discount	number	必须		商品折扣
├─ store_name	string	必须		店铺名称
├─ id	string	必须		商品ID
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_vat	integer	必须		商品是否开具增值税发票 1:是 0:否	format: int32
├─ type_id	string	必须		商品类型ID
├─ goods_advword	string	必须		商品广告词
├─ brand_name	string	必须		品牌名称
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goods_storage_alarm	integer	必须		商品库存报警值	format: int32
├─ brand_id	string	必须		品牌ID
├─ goods_freight	number	必须		商品运费 0为免运费
├─ gc_name	string	必须		商品分类名称
├─ goods_serial	string	必须		商品编号
├─ image_path	string	必须		商品默认图片
├─ spec_value	string	必须		规格值
├─ goods_marketprice	number	必须		商品市场价
├─ price_max	number	必须		最高价

商品服务（goods）-商品查询管理（外部）

查询商城全部商品

基本信息

Path： /goods/public/goods/queryMallGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_name	string	非必须
pageno	integer	必须		当前页码数	format: int32
gc_id	string	非必须
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须
price_min	string	非必须
app_id	string	必须		应用ID
price_max	string	非必须
order	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ is_virtual	integer	非必须			format: int32
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_price_max	number	必须		商品价格范围最大值
├─ goods_image	string	必须		商品默认图片
├─ follow_count	integer	非必须			format: int32
├─ goods_price_min	number	必须		商品价格范围最小值
├─ goods_id	string	必须		商品ID
├─ store_name	string	必须		店铺名称
├─ goods_marketprice	number	必须		商品市场价
├─ goods_commend	integer	必须		商品推荐,1表示是,0表示否	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

商品搜索（商城首页）

基本信息

Path： /goods/public/goods/queryIndex

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须
goods_name	string	非必须		商品名称或关键字
type_id	string	非必须		商品类型ID
gc_id	string	非必须		商品分类ID
goods_advword	string	非必须
sort	string	非必须		排序规则
area_id	string	非必须		区域ID
price_min	number	必须		最小价格
attrs	object []	非必须		商品属性组	item 类型: object
├─ attrvalues	string []	非必须		属性值ID组	item 类型: string
├─		非必须
├─ attr_id	string	非必须		属性ID
brand_id	string	非必须		品牌ID
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
goods_state	string	非必须
store_name	string	非必须
app_id	string	必须		应用ID
price_max	number	必须		最大价格
city_id	string	非必须		城市ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ ref_id	string	必须		应用关联商品ID
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_price	number	必须		商品价格
├─ gc_id	string	非必须
├─ goods_advword	string	非必须
├─ goods_id	string	必须		商品ID
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goods_discount_price	number	非必须		商品折后价
├─ goods_salenum	integer	必须		销量	format: int64
├─ goods_image	string	必须		商品默认图片
├─ goods_discount	number	必须		商品折扣
├─ store_name	string	必须		店铺名称
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

店铺商品查询（消费者在店铺搜索商品）

基本信息

Path： /goods/public/goods/queryGoodsInStore

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_name	string	非必须		商品名称
pageno	integer	必须		当前页码数	format: int32
gc_id	string	非必须		商品分类ID
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
price_min	number	非必须		最小价格
price_max	number	非必须		最大价格
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ ref_id	string	必须		应用关联商品ID
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_price	number	必须		商品价格
├─ gc_id	string	非必须
├─ goods_advword	string	非必须
├─ goods_id	string	必须		商品ID
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goods_discount_price	number	非必须		商品折后价
├─ goods_salenum	integer	必须		销量	format: int64
├─ goods_image	string	必须		商品默认图片
├─ goods_discount	number	必须		商品折扣
├─ store_name	string	必须		店铺名称
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

获取电子菜谱对应的点餐单（包含店铺信息）

基本信息

Path： /goods/public/goods/queryGoodsByRef

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
distance	number	必须		搜索距离范围（米）	format: double
ref_ids	string []	必须		电子菜谱ID数组	item 类型: string
├─		非必须
gc_id	string	必须		商品分类ID
latitude	number	必须		目标纬度	format: double
area_id	string	非必须		区域ID
city_id	string	非必须		城市ID
longitude	number	必须		目标经度	format: double

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ ref_id	string	必须		电子菜谱商品ID
├─ ref_name	string	必须		电子菜谱商品名称
├─ store_infos	object []	必须		店铺商品信息	item 类型: object
├─ ref_id	string	必须		电子菜谱ID
├─ goods_name	string	必须		商品名称
├─ store_info	object	必须
├─ store_id	string	必须		店铺ID
├─ distance	number	必须		与店铺距离（米）	format: double
├─ is_open	integer	必须		是否营业：0休息1营业中	format: int32
├─ store_logo	string	必须		店铺LOGO
├─ store_name	string	必须		店铺名称
├─ store_workingtime	string	必须		店铺营业时间
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		分类ID
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_discount	number	必须		商品折扣
├─ goods_id	string	必须		商品ID
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_discount_price	number	必须		商品折后价
├─ ref_image	object []	必须		电子菜谱商品图片	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32

查看商品详情（商家管理商品）

基本信息

Path： /goods/goods/getGoodsInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ create_time	string	必须		创建时间	format: date-time
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		分类ID
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_id	string	必须		商品ID
├─ goods_attr	object []	必须		商品属性组	item 类型: object
├─ attr_name	string	必须		属性名称
├─ attrvalue	object []	必须		属性值组	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ is_checked	string	必须		属性值是否选中
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ gc_name	string	必须		分类名称
├─ goods_serial	string	必须		商品编号
├─ update_time	string	必须		更新时间	format: date-time
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_groups	object []	必须		商品关联商品分组	item 类型: object
├─ storegc_id	string	必须		商品分组ID
├─ storegc_name	string	必须		商品分组名称
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_body	string	必须		商品详情
├─ goods_marketprice	number	必须		市场价格
├─ need_matching	string	必须		1：需要撮合，0：无需，默认是0
├─ tomorrow_storage	string	必须		明天默认库存

根据角色获取商品信息详情

基本信息

Path： /goods/goods/getGoodsDetailByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ is_virtual	integer	必须		是否为虚拟商品 1:是 0:否	format: int32
├─ ref_id	string	必须		应用关联商品ID
├─ type_name	string	必须		类型名称
├─ gc_full_path	string	必须		商品分类完整路径冗余
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		商品分类ID
├─ goods_storage	integer	必须		总库存	format: int32
├─ evaluation_count	integer	必须		评价数	format: int64
├─ goods_attr	object []	必须		商品属性组	item 类型: object
├─ attr_name	string	必须		属性名称
├─ attrvalue	object []	必须		属性值组	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ is_checked	string	必须		属性值是否选中
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ extend_info	string	必须		扩展信息
├─ goods_discount_price	number	必须		商品折后价
├─ goods_salenum	integer	必须		销量	format: int64
├─ is_del	string	非必须
├─ goods_discount	number	必须		商品折扣
├─ store_name	string	必须		店铺名称
├─ goods_body	string	必须		商品内容
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_vat	integer	必须		商品是否开具增值税发票 1:是 0:否	format: int32
├─ type_id	string	必须		类型ID
├─ goods_advword	string	必须		商品关键字
├─ goods_id	string	必须		商品ID
├─ brand_name	string	必须		品牌名称
├─ goods_desc	string	必须		商品描述
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goods_storage_alarm	integer	必须		商品库存报警值	format: int32
├─ brand_id	string	必须		品牌ID
├─ goods_freight	number	必须		商品运费 0为免运费
├─ gc_name	string	必须		商品分类名称
├─ goods_serial	string	必须		商品编号
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_marketprice	number	必须		商品市场价
├─ goods_spec	object []	必须		商品规格组	item 类型: object
├─ spec_id	string	必须		规格ID
├─ spec_name	string	必须		规格名称
├─ specvalues	object []	必须		规格值组	item 类型: object
├─ specvalue_name	string	必须		规格值名称
├─ is_checked	string	必须		规格值是否选中
├─ specvalue_id	string	必须		规格值ID
├─ need_matching	string	必须		1：需要撮合，0：无需，默认是0
├─ tomorrow_storage	string	必须		明天默认库存
├─ goods_pkg	object	必须		商品套餐
├─ max	string	必须		最大价格
├─ min	string	必须		最小价格
├─ discount_amount	string	必须		折后价
├─ pkg_goods	object []	必须		套餐商品	item 类型: object
├─ group_name	string	必须		分组名称
├─ goods_num	string	必须		分组中规定个数
├─ group_index	string	必须		分组排序
├─ pkg_goods	object []	必须		分组的商品	item 类型: object
├─ goods_id	string	必须		商品id
├─ goods_price	string	必须		商品价格
├─ goods_discount	string	必须		商品折扣

根据商品ID获取商品详情页（消费者查看某个商品详情）

基本信息

Path： /goods/public/goods/getGoodsDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ is_virtual	integer	必须		是否为虚拟商品 1:是 0:否	format: int32
├─ ref_id	string	必须		应用关联商品ID
├─ type_name	string	必须		类型名称
├─ gc_full_path	string	必须		商品分类完整路径冗余
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		商品分类ID
├─ goods_storage	integer	必须		总库存	format: int32
├─ evaluation_count	integer	必须		评价数	format: int64
├─ goods_attr	object []	必须		商品属性组	item 类型: object
├─ attr_name	string	必须		属性名称
├─ attrvalue	object []	必须		属性值组	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ is_checked	string	必须		属性值是否选中
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ extend_info	string	必须		扩展信息
├─ goods_discount_price	number	必须		商品折后价
├─ goods_salenum	integer	必须		销量	format: int64
├─ is_del	string	非必须
├─ goods_discount	number	必须		商品折扣
├─ store_name	string	必须		店铺名称
├─ goods_body	string	必须		商品内容
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_vat	integer	必须		商品是否开具增值税发票 1:是 0:否	format: int32
├─ type_id	string	必须		类型ID
├─ goods_advword	string	必须		商品关键字
├─ goods_id	string	必须		商品ID
├─ brand_name	string	必须		品牌名称
├─ goods_desc	string	必须		商品描述
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goods_storage_alarm	integer	必须		商品库存报警值	format: int32
├─ brand_id	string	必须		品牌ID
├─ goods_freight	number	必须		商品运费 0为免运费
├─ gc_name	string	必须		商品分类名称
├─ goods_serial	string	必须		商品编号
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_marketprice	number	必须		商品市场价
├─ goods_spec	object []	必须		商品规格组	item 类型: object
├─ spec_id	string	必须		规格ID
├─ spec_name	string	必须		规格名称
├─ specvalues	object []	必须		规格值组	item 类型: object
├─ specvalue_name	string	必须		规格值名称
├─ is_checked	string	必须		规格值是否选中
├─ specvalue_id	string	必须		规格值ID
├─ need_matching	string	必须		1：需要撮合，0：无需，默认是0
├─ tomorrow_storage	string	必须		明天默认库存
├─ goods_pkg	object	必须		商品套餐
├─ max	string	必须		最大价格
├─ min	string	必须		最小价格
├─ discount_amount	string	必须		折后价
├─ pkg_goods	object []	必须		套餐商品	item 类型: object
├─ group_name	string	必须		分组名称
├─ goods_num	string	必须		分组中规定个数
├─ group_index	string	必须		分组排序
├─ pkg_goods	object []	必须		分组的商品	item 类型: object
├─ goods_id	string	必须		商品id
├─ goods_price	string	必须		商品价格
├─ goods_discount	string	必须		商品折扣

根据商品分组查询店铺商品列表（商家管理商品）

基本信息

Path： /goods/goods/queryStoreAllGoodsByGroup

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_name	string	非必须		商品名称
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
storegc_ids	string []	非必须		商品分组ID数组	item 类型: string
├─		非必须
goods_state	string	非必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
sort	string	非必须		排序规则
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ goods_name	string	必须		商品名称
├─ update_time	string	必须		更新时间	format: date-time
├─ goods_image	string	必须		商品默认图片
├─ create_time	string	非必须			format: date-time
├─ goods_groups	object []	必须		分组信息	item 类型: object
├─ storegc_id	string	必须		商品分组ID
├─ storegc_name	string	必须		商品分组名称
├─ goods_price	number	必须		商品价格
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_id	string	必须		商品ID
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询店铺不同状态商品列表（商家管理商品）

基本信息

Path： /goods/goods/queryStoreGoodsByState

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_name	string	非必须		商品名称
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
storegc_ids	string []	非必须		商品分组ID数组	item 类型: string
├─		非必须
goods_state	string	非必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
goods_type	string	必须		商品类型
sort	string	非必须		排序规则
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ goods_name	string	必须		商品名称
├─ update_time	string	必须		更新时间	format: date-time
├─ goods_image	string	必须		商品默认图片
├─ create_time	string	非必须			format: date-time
├─ goods_price	number	必须		商品价格
├─ goods_storage	integer	必须		总库存	format: int32
├─ goods_id	string	必须		商品ID
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询店铺全部商品列表（商家管理商品）

基本信息

Path： /goods/goods/queryStoreAllGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_name	string	非必须		商品名称
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
storegc_ids	string []	非必须		商品分组ID数组	item 类型: string
├─		非必须
goods_state	string	非必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
sort	string	非必须		排序规则
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ goods_name	string	必须		商品名称
├─ update_time	string	必须		更新时间	format: date-time
├─ goods_image	string	必须		商品默认图片
├─ create_time	string	非必须			format: date-time
├─ goods_groups	object []	必须		分组信息	item 类型: object
├─ storegc_id	string	必须		商品分组ID
├─ storegc_name	string	必须		商品分组名称
├─ goods_price	number	必须		商品价格
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_id	string	必须		商品ID
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ tomorrow_storage	string	必须		1：需要撮合，0：无需，默认是0
├─ need_matching	string	必须		1：需要撮合，0：无需，默认是0
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询店铺商品列表

基本信息

Path： /goods/public/goods/queryStoreGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_name	string	非必须		商品名称
pageno	integer	必须		当前页码数	format: int32
gc_id	string	非必须		商品分类ID
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
price_min	number	非必须		最小价格
price_max	number	非必须		最大价格
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ is_virtual	integer	非必须			format: int32
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_price_max	number	必须		商品价格范围最大值
├─ goods_image	string	必须		商品默认图片
├─ follow_count	integer	非必须			format: int32
├─ goods_price_min	number	必须		商品价格范围最小值
├─ goods_id	string	必须		商品ID
├─ store_name	string	必须		店铺名称
├─ goods_marketprice	number	必须		商品市场价
├─ goods_commend	integer	必须		商品推荐,1表示是,0表示否	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询店铺的商品列表（不分页）

基本信息

Path： /goods/public/goods/queryGoodsByStore

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须		店铺ID
goods_name	string	非必须		商品名称或关键字
gc_id	string	非必须		商品分类ID
goods_advword	string	非必须
sort	string	非必须		排序规则
price_min	number	非必须
price_max	number	非必须
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ ref_id	string	必须		应用关联商品ID
├─ goods_name	string	必须		商品名称
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		分类ID
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_discount	number	非必须		商品折扣
├─ goods_id	string	必须		商品ID
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_discount_price	number	必须		商品折后价

查询店铺的商品统计列表

基本信息

Path： /goods/public/goods/queryGoodsCountByStore

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须		店铺ID
goods_name	string	非必须		商品名称或关键字
gc_id	string	非必须		商品分类ID
goods_advword	string	非必须		商品关键字
sort	string	非必须		排序规则
price_min	number	非必须		商品折后价，大于等于该价格的条件
price_max	number	非必须		商品折后价，小于等于该价格的条件
order	string	非必须		排序字段
state_count	boolean	非必须		状态统计
goodsType	integer []	非必须		商品类型	item 类型: integer
├─		非必须
pageno	integer	必须		页数
pagesize	integer	必须		每页的记录数
goodsState	string	非必须		商品
reciver_addr_position	string	必须		收货人地址坐标

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ goods_list	object	必须		扩展信息
├─ goods_id	string	必须		商品ID
├─ goods_name	string	必须		商品名称
├─ goods_type	integer	必须		商品类型（应用方定义）
├─ goods_desc	string	必须		商品描述
├─ gc_id	string	必须		商品分类ID
├─ goods_price	number	必须		商品价格
├─ goods_discount_price	number	必须		商品折后价
├─ goods_discount	number	必须		商品折扣
├─ goods_storage	integer	必须		总库存
├─ extend_info	string	必须		扩展信息JSON
├─ ref_id	string	必须		应用关联商品ID
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑 5：售空
├─ discount_amount	number	必须
├─ price_min	number	必须
├─ price_max	number	必须
├─ goods_specs	integer	必须
├─ packing_fee	number	必须
├─ goods_storage_check	integer	必须
├─ pkg_spec	string	必须
├─ need_matching	integer	必须		撮合开关 0=关，1=开
├─ tomorrow_storage	integer	必须		每日库存
├─ goods_image	object []	必须		商品图片集合	item 类型: object
├─ id	string	必须
├─ image_path	string	必须		商品图片路径
├─ sort	integer	必须		商品图片排序
├─ is_default	integer	必须		商品图片默认主图，1是，0否
├─ file_type	integer	必须		文件类型：1图片2视频
├─ is_no_stock	integer	必须		套餐是否售空 0有库存1售空
├─ state_count	object	必须		商品折后价
├─ total	integer	必须
├─ on_shelf	integer	必须
├─ off_shelf	integer	必须
page	object	必须		分页数据
├─ pagesize	integer	必须		单页显示的记录数
├─ pageno	integer	必须		当前页
├─ records	integer	必须		总记录数
├─ total	integer	必须		总页数

查询草稿箱内商品列表（商家管理商品）

基本信息

Path： /goods/goods/queryDraftGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_name	string	非必须		商品名称
pageno	integer	必须		当前页码数	format: int32
gc_id	string	非必须		商品分类ID
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
price_min	number	非必须		最小价格
price_max	number	非必须		最大价格
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		商品分类名称
├─ goods_name	string	必须		商品名称
├─ goods_image	string	必须		商品默认图片
├─ create_time	string	必须		添加时间	format: date-time
├─ gc_id	string	必须		商品分类ID
├─ goods_id	string	必须		商品ID
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询店铺可推广商品列表（商家管理商品）

基本信息

Path： /goods/goods/querySpreadGoods

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_name	string	非必须		商品名称
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ goods_name	string	必须		商品名称
├─ goods_serial	string	必须		商品编号
├─ goods_image	string	必须		商品默认图片
├─ goods_id	string	必须		商品ID
├─ goods_desc	string	必须		商品描述
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询商品信息（商家管理修改商品信息时使用）

基本信息

Path： /goods/goods/getGoodsInfoForEdit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		分类ID
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_id	string	必须		商品ID
├─ goods_attr	object []	必须		商品属性组	item 类型: object
├─ attr_name	string	必须		属性名称
├─ attr_type	integer	必须		属性类别1选择类型2手动输入类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值组	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ is_checked	string	必须		是否勾选
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ app_id	string	必须		应用ID
├─ app_id	string	必须		应用ID
├─ attr_id	string	必须		属性ID
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_groups	object []	必须		商品关联商品分组	item 类型: object
├─ storegc_id	string	必须		商品分组ID
├─ storegc_name	string	必须		商品分组名称
├─ goods_body	string	必须		商品详情
├─ goods_marketprice	number	必须		市场价格
├─ tomorrow_storage	string	必须
├─ need_matching	string	必须		1：需要撮合，0：无需，默认是0

商品服务（goods）-商品分类管理（外部）

添加商品分类

基本信息

Path： /goods/goodsclass/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_name	string	必须		商品分类名称
type_id	string	非必须		类型id
sort	integer	必须		商品分类排序	format: int32
app_id	string	非必须		应用ID
gc_parent_id	string	非必须		商品分类上级ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品分类ID

更新商品分类

基本信息

Path： /goods/goodsclass/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_name	string	必须		商品分类名称
type_id	string	非必须		类型id
id	string	必须		分类ID
sort	integer	必须		商品分类排序	format: int32
gc_parent_id	string	非必须		商品分类上级ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除商品分类

基本信息

Path： /goods/goodsclass/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

修改商品分类关联的商品类型

基本信息

Path： /goods/goodsclass/updateGoodsType

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
type_id	string	非必须		类型ID
gc_id	string	必须		分类ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

批量删除商品分类

基本信息

Path： /goods/goodsclass/batchDelete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
delete_ids	string []	必须		商品分类ID数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

获取商品分类详情

基本信息

Path： /goods/goodsclass/get

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ gc_name	string	必须		分类名称
├─ gc_show	integer	必须		商品分类前台显示0:否1:是	format: int32
├─ type_name	string	非必须		类型名称
├─ gc_virtual	integer	必须		是否允许发布虚拟商品1:是0否	format: int32
├─ level	integer	必须		树型结构层级，使用数字表示	format: int32
├─ gc_full_path	string	必须		分类完整路径，上级分类ID加下划线拼接分类ID
├─ type_id	string	必须		类型id
├─ id	string	必须		分类ID
├─ sort	integer	必须		商品分类排序	format: int32
├─ gc_parent_id	string	必须		商品分类上级ID
├─ status	integer	非必须		状态0待审核1审核通过（只有1才是系统类型，其它都为自定义类型）2审核不通过	format: int32

按层级返回分类列表

基本信息

Path： /goods/goodsclass/listByLevel

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_name	string	非必须		分类名称
level	integer	必须		分类层级	format: int32
pageno	integer	必须		页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
gc_parent_id	string	非必须		父分类ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		分类名称
├─ type_name	string	必须		类型名称
├─ create_time	string	必须		申请时间	format: date-time
├─ level	integer	必须		分类层级	format: int32
├─ user_name	string	必须		申请人
├─ gc_parent_name	string	必须		父分类名称
├─ id	string	必须		分类ID
├─ sort	integer	必须		分类排序	format: int32
├─ app_id	string	非必须		应用ID
├─ gc_parent_id	string	必须		父分类ID
├─ status	integer	必须		审核状态：0待审核1审核通过2审核不通过	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询当前商品绑定的商品类型信息（一级分类无扩展属性）

基本信息

Path： /goods/goodsclass/getBindTypesInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
type_id	string	非必须		类型ID
id	string	必须		分类ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ extend_attrs	object []	必须		扩展的属性信息	item 类型: object
├─ type_name	string	非必须		类型名称
├─ attr_name	string	必须		属性名称
├─ parent_status	integer	非必须		0表示未覆盖，1表示已覆盖	format: int32
├─ type_id	string	非必须		类型ID
├─ attr_type	integer	必须		属性类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ gc_id	string	必须		分类ID
├─ direct_attrs	object []	必须		直接关联的属性信息	item 类型: object
├─ type_name	string	非必须		类型名称
├─ attr_name	string	必须		属性名称
├─ parent_status	integer	非必须		0表示未覆盖，1表示已覆盖	format: int32
├─ type_id	string	非必须		类型ID
├─ attr_type	integer	必须		属性类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ direct_type_id	string	必须		直接关联的类型ID
├─ direct_type_name	string	必须		直接关联的类型名称

根据当前层级查询所有父层级商品分类（用于二级三级分类列表下拉框）

基本信息

Path： /goods/goodsclass/findParentByLevel

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
level	integer	必须		树型结构层级，使用数字表示	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		商品分类下级分类名称
├─ child_goods_class	[]	必须		商品分类下级分类数据
├─		非必须
├─ level	integer	必须		商品分类层级	format: int32
├─ id	string	必须		商品分类ID
├─ sort	integer	必须		商品分类排序	format: int32
├─ gc_parent_id	string	必须		商品分类上级ID

查询所有商品分类（用于父分类下拉框）

基本信息

Path： /goods/goodsclass/findAllGoodsClass

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		商品分类下级分类名称
├─ child_goods_class	[]	必须		商品分类下级分类数据
├─		非必须
├─ level	integer	必须		商品分类层级	format: int32
├─ id	string	必须		商品分类ID
├─ sort	integer	必须		商品分类排序	format: int32
├─ gc_parent_id	string	必须		商品分类上级ID

查询平级子节点分类

基本信息

Path： /goods/goodsclass/queryParallelCategory

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		父分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		分类名称
├─ gc_show	integer	必须		商品分类前台显示0:否1:是	format: int32
├─ type_name	string	非必须		类型名称
├─ gc_virtual	integer	必须		是否允许发布虚拟商品1:是0否	format: int32
├─ level	integer	必须		树型结构层级，使用数字表示	format: int32
├─ gc_full_path	string	必须		分类完整路径，上级分类ID加下划线拼接分类ID
├─ type_id	string	必须		类型id
├─ id	string	必须		分类ID
├─ sort	integer	必须		商品分类排序	format: int32
├─ gc_parent_id	string	必须		商品分类上级ID
├─ status	integer	非必须		状态0待审核1审核通过（只有1才是系统类型，其它都为自定义类型）2审核不通过	format: int32

查询父级分类关联所有属性

基本信息

Path： /goods/goodsclass/getParentAttr

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ type_name	string	非必须		类型名称
├─ attr_name	string	必须		属性名称
├─ parent_status	integer	非必须		0表示未覆盖，1表示已覆盖	format: int32
├─ type_id	string	非必须		类型ID
├─ attr_type	integer	必须		属性类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID

查询系统商品分类列表（标注分类使用状态）

基本信息

Path： /goods/goodsclass/listAllSystem

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_name	string	非必须		分类名称
pageno	integer	必须		页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
app_id	string	必须		应用ID
gc_parent_id	string	非必须		父分类ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		分类名称
├─ use_state	integer	必须		使用状态：0未使用，1已使用，2已选择	format: int32
├─ level	integer	必须		分类层级	format: int32
├─ gc_parent_name	string	必须		父分类名称
├─ id	string	必须		分类ID
├─ sort	integer	必须		分类排序	format: int32
├─ gc_parent_id	string	必须		父分类ID
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询商品类型及包含的属性、属性值列表

基本信息

Path： /goods/goodsclass/getTypesDetails

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ type_name	string	必须		类型名称
├─ type_id	string	必须		类型ID
├─ attrs	object []	必须		类型下的属性列表	item 类型: object
├─ type_name	string	非必须		类型名称
├─ attr_name	string	必须		属性名称
├─ parent_status	integer	非必须		0表示未覆盖，1表示已覆盖	format: int32
├─ type_id	string	非必须		类型ID
├─ attr_type	integer	必须		属性类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询商品分类关联的所有属性和属性值

基本信息

Path： /goods/goodsclass/findGoodscalssRelationAttr

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
id	string	必须		分类ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ attr_name	string	必须		属性名称
├─ attr_type	integer	必须		属性类别1选择类型2手动输入类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值组	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ is_checked	string	必须		是否勾选
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ app_id	string	必须		应用ID
├─ app_id	string	必须		应用ID
├─ attr_id	string	必须		属性ID

审核应用分类

基本信息

Path： /goods/goodsclass/audit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须		审批结果
gc_ids	string []	必须		分类ID	item 类型: string
├─		非必须
status	integer	必须		审批状态	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

管理员查询审核分类列表

基本信息

Path： /goods/goodsclass/auditList

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_name	string	非必须		分类名称
pageno	integer	必须		页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
status	integer	必须		审核状态:0待审核1审核通过2审核不通过	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		分类名称
├─ type_name	string	必须		类型名称
├─ create_time	string	必须		申请时间	format: date-time
├─ level	integer	必须		分类层级	format: int32
├─ user_name	string	必须		申请人
├─ gc_parent_name	string	必须		父分类名称
├─ id	string	必须		分类ID
├─ sort	integer	必须		分类排序	format: int32
├─ app_id	string	非必须		应用ID
├─ gc_parent_id	string	必须		父分类ID
├─ status	integer	必须		审核状态：0待审核1审核通过2审核不通过	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

管理员查看待审核分类详情

基本信息

Path： /goods/goodsclass/auditDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ create_time	string	必须		申请时间	format: date-time
├─ level	integer	必须		分类层级	format: int32
├─ gc_full_path	string	非必须
├─ user_name	string	必须		申请人
├─ gc_id	string	必须		分类ID
├─ gc_parent_name	string	必须		父分类名称
├─ sort	integer	必须		分类排序	format: int32
├─ direct_type_name	string	必须		直接关联的类型名称
├─ result	string	必须		审核结果
├─ app_name	string	必须		应用名称
├─ gc_name	string	必须		分类名称
├─ extend_attrs	object []	必须		扩展属性信息	item 类型: object
├─ type_name	string	非必须		类型名称
├─ attr_name	string	必须		属性名称
├─ parent_status	integer	非必须		0表示未覆盖，1表示已覆盖	format: int32
├─ type_id	string	非必须		类型ID
├─ attr_type	integer	必须		属性类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ direct_attrs	object []	必须		直接关联的属性信息	item 类型: object
├─ type_name	string	非必须		类型名称
├─ attr_name	string	必须		属性名称
├─ parent_status	integer	非必须		0表示未覆盖，1表示已覆盖	format: int32
├─ type_id	string	非必须		类型ID
├─ attr_type	integer	必须		属性类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ direct_type_id	string	必须		直接关联的类型ID
├─ app_id	string	必须		应用ID
├─ gc_parent_id	string	必须		父分类ID
├─ status	integer	必须		审核状态：0待审核1审核通过2审核不通过	format: int32

查询应用可用系统分类

基本信息

Path： /goods/goodsclass/findAppTreeCategories

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ gc_name	string	必须		商品分类下级分类名称
├─ child_goods_class	[]	必须		商品分类下级分类数据
├─		非必须
├─ level	integer	必须		商品分类层级	format: int32
├─ id	string	必须		商品分类ID
├─ sort	integer	必须		商品分类排序	format: int32
├─ gc_parent_id	string	必须		商品分类上级ID

查询应用可用的系统分类

基本信息

Path： /goods/goodsclass/findAvailableCategories

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	非必须
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ gc_name	string	非必须
├─ be_used	boolean	非必须
├─ child_goods_class	[]	非必须
├─		非必须
├─ level	integer	非必须			format: int32
├─ gc_full_path	string	非必须
├─ id	string	非必须
├─ sort	integer	非必须			format: int32
├─ gc_parent_id	string	非必须

查询应用申请分类列表

基本信息

Path： /goods/goodsclass/listByAppId

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
app_id	string	必须		应用ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ result	string	必须		审核结果
├─ gc_name	string	必须		分类名称
├─ create_time	string	必须		申请时间	format: date-time
├─ level	integer	必须		分类层级	format: int32
├─ user_name	string	必须		申请人
├─ gc_parent_name	string	必须		父分类名称
├─ mall_gc_id	string	必须		应用商品分类ID
├─ id	string	必须		分类ID
├─ sort	integer	必须		分类排序	format: int32
├─ gc_parent_id	string	必须		父分类ID
├─ status	integer	必须		审核状态：0待审核1审核通过2审核不通过	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

批量添加应用使用系统商品分类

基本信息

Path： /goods/mallgoodsclass/batchAdd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
choose_goodsclass	string []	必须		已选择的分类ID数组	item 类型: string
├─		非必须
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

批量删除应用正在使用系统商品分类

基本信息

Path： /goods/mallgoodsclass/batchDelete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_ids	string []	必须		商品分类ID数组	item 类型: string
├─		非必须
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询应用正在使用的分类列表

基本信息

Path： /goods/goodsclass/listUseByApp

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_name	string	非必须		分类名称
pageno	integer	必须		页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
app_id	string	必须		应用ID
gc_parent_id	string	非必须		父分类ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ result	string	必须		审核结果
├─ gc_name	string	必须		分类名称
├─ create_time	string	必须		申请时间	format: date-time
├─ level	integer	必须		分类层级	format: int32
├─ user_name	string	必须		申请人
├─ gc_parent_name	string	必须		父分类名称
├─ mall_gc_id	string	必须		应用商品分类ID
├─ id	string	必须		分类ID
├─ sort	integer	必须		分类排序	format: int32
├─ gc_parent_id	string	必须		父分类ID
├─ status	integer	必须		审核状态：0待审核1审核通过2审核不通过	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

删除自定义商品分类及关联的自定义类型属性属性值

基本信息

Path： /goods/goodsclass/deleteCustomGc

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_id	string	必须		商品分类ID
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

应用查询商品分类详情

基本信息

Path： /goods/goodsclass/getDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ gc_name	string	必须		商品分类名称
├─ type_name	string	必须		类型名称
├─ level	integer	必须		树型结构层级，使用数字表示	format: int32
├─ type_id	string	必须		类型id
├─ gc_parent_name	string	必须		商品分类上级名称
├─ id	string	必须		商品分类ID
├─ sort	integer	必须		商品分类排序	format: int32
├─ app_id	string	非必须
├─ attrs	object []	必须		类型下的属性列表	item 类型: object
├─ attr_name	string	必须		属性名称
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值列表	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ gc_parent_id	string	必须		商品分类上级ID

查询分类下类型关联的自定义属性

基本信息

Path： /goods/goodsclass/getCustomAttr

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
type_id	string	必须		类型ID
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ type_name	string	必须		类型名称
├─ attr_name	string	必须		属性名称
├─ type_id	string	必须		类型ID
├─ attr_type	integer	必须		属性类别1选择类型2手动输入类型	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值列表	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID

应用查询商品分类和系统属性值自定义属性值

基本信息

Path： /goods/goodsclass/getSystemDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ gc_name	string	必须		商品分类名称
├─ type_name	string	必须		类型名称
├─ level	integer	必须		树型结构层级，使用数字表示	format: int32
├─ type_id	string	必须		类型id
├─ gc_parent_name	string	必须		商品分类上级名称
├─ id	string	必须		商品分类ID
├─ sort	integer	必须		商品分类排序	format: int32
├─ attrs	object []	必须		类型下的属性列表	item 类型: object
├─ attr_name	string	必须		属性名称
├─ is_override	integer	必须		系统属性状态：0正常，1已覆盖	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值列表	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ app_id	string	必须		应用ID，为空表示系统属性值，否则为应用属性值
├─ attr_id	string	必须		属性ID
├─ gc_parent_id	string	必须		商品分类上级ID

商品服务（goods）-商品相册管理（外部）

批量更新商品图片

基本信息

Path： /goods/goodsImages/updateGoodsImage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
image_details	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

设置商品相册中默认图片

基本信息

Path： /goods/goodsImages/setDefaultImage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
image_id	string	必须		图片ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除（批量删除）商品相册中图片

基本信息

Path： /goods/goodsImages/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
image_ids	string []	必须		图片ID数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询商品下全部图片

基本信息

Path： /goods/goodsImages/findByGoodsId

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32

查询商品相册全部图片

基本信息

Path： /goods/goodsImages/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	非必须			item 类型: object
├─ store_id	string	非必须
├─ file_type	integer	非必须			format: int32
├─ image_path	string	非必须
├─ goods_id	string	非必须
├─ id	string	非必须
├─ sort	integer	非必须			format: int32
├─ is_default	integer	非必须			format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

商品服务（goods）-商品详情页管理（外部）

更新商品详情页内容

基本信息

Path： /goods/goods/updateGoodsContent

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
goods_body	string	必须		商品详情页内容

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

获取商品详情页内容

基本信息

Path： /goods/goods/getGoodsContent

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ goods_id	string	必须		商品ID
├─ goods_body	string	必须		商品详情页内容

商品服务（goods）-商品价格库存管理（外部）

更新商品价格

基本信息

Path： /goods/goods/updateGoodsPrice

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_price	number	必须		商品价格
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新商品库存

基本信息

Path： /goods/goods/updateGoodsStorage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_storage	integer	必须		商品库存	format: int32
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新商品默认库存

基本信息

Path： /goods/goods/updateGoodsTomorrowStorage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
tomorrow_storage	integer	必须		商品库存	format: int32
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

调整(增减)商品库存

基本信息

Path： /goods/goods/adjustGoodsStorage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_storage	integer	必须		商品库存	format: int32
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

调整(增减)商品默认库存

基本信息

Path： /goods/goods/adjustTomorrowStorage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
tomorrow_storage	integer	必须		商品默认库存	format: int32
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

商品服务（goods）-商品上下架（外部）

批量更新商品上下架状态（按角色）

基本信息

Path： /goods/goods/batchUpdateGoodsStateByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_state	string	必须		商品状态,0表示下架,1表示正常
goods_ids	string []	必须		商品ID数组	item 类型: string
├─		非必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

批量更新商品上下架状态

基本信息

Path： /goods/goods/batchUpdateGoodsState

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_state	string	必须		商品状态,0表示下架,1表示正常
goods_ids	string []	必须		商品ID数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新商品上下架状态

基本信息

Path： /goods/goods/updateGoodsState

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
goods_state	string	必须		商品状态,0表示下架,1表示正常

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

商品服务（goods）-购物车管理（外部）

添加商品至购物车（按角色）

基本信息

Path： /goods/cart/addByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
chain_id	string	非必须		传播链ID
goods_id	string	必须		商品ID
goods_num	integer	必须		商品数量	format: int32
spec_param	object []	非必须		商品规格组合	item 类型: object
├─ spec_id	string	非必须		规格ID
├─ specvalue_name	string	非必须		规格值名称
├─ specvalue_id	string	非必须		规格值ID
├─ spec_name	string	非必须		规格名称
app_id	string	非必须
extend_info	string	非必须		购物车扩展信息
member_id	string	非必须		会员ID
pkg_group	object []	必须			item 类型: object
├─ group_name	string	必须		商品分组
├─ goods_num	integer	必须
├─ goods_list	string []	必须		商品列表	item 类型: string
├─		非必须
├─ goods_data_list	object []	必须			item 类型: object
├─ goods_id	string	必须
├─ goods_discount	number	必须
├─ goods_price	number	必须
├─ index	integer	必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_details	object []	必须		店铺购物车详情	item 类型: object
├─ store_id	string	必须		店铺ID
├─ store_state	integer	非必须			format: int32
├─ store_goods_amount	integer	必须		店铺商品购买数量	format: int32
├─ store_name	string	必须		店铺名称
├─ store_cart_list	object []	必须		店铺购物车列表	item 类型: object
├─ store_id	string	非必须
├─ goods_name	string	必须		商品名称
├─ chain_id	string	必须		传播链ID
├─ specparam_name	string	必须		商品规格名称
├─ goods_price	number	必须		商品价格
├─ goods_storage	integer	非必须			format: int32
├─ goods_id	string	必须		商品ID
├─ buyer_id	string	非必须
├─ extend_info	string	必须		扩展信息
├─ image_path	string	必须		商品图片
├─ specparam_id	string	必须		商品规格ID
├─ goods_discount	number	必须		商品折扣
├─ goods_num	integer	必须		商品购买数量	format: int32
├─ goods_state	string	必须		商品状态
├─ store_name	string	非必须
├─ id	string	必须		购物车ID
├─ app_id	string	必须		应用ID
├─ goods_storage_check	string	必须		是否验证库存：0验证 1不验证
├─ goods_pkg	object []	必须			item 类型: object
├─ discount_amount	number	必须		优惠金额
├─ max	number	必须		最大价格
├─ min	number	必须		最小价格
├─ pkg_goods	object	必须		套餐内分组
├─ goods_num	integer	必须		限制数量
├─ group_name	string	必须		分组名称
├─ pkg_goods	object []	必须		具体商品情况	item 类型: object
├─ goods_discount	number	必须		商品折扣
├─ goods_id	string	必须		商品id
├─ goods_name	string	必须		商品名称
├─ goods_price	number	必须		商品价格
├─ goods_state	integer	必须		商品状态 商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_storage_check	integer	必须		是否验证库存：0验证 1不验证
├─ image_path	string	必须		商品默认图片
├─ goods_storage	integer	必须		商品库存
├─ packing_fee	number	必须
├─ need_matching	integer	必须		撮合开关 0=关，1=开
├─ pkg_spec	string	必须
├─ goods_type	integer	必须
├─ pkg_goods	object []	必须			item 类型: object
├─ goods_id	string	必须
├─ goods_name	string	必须
├─ goods_price	number	必须
├─ goods_discount	number	必须
├─ image_path	string	必须
├─ goods_state	string	必须
├─ goods_storage_check	integer	必须
├─ goods_storage	integer	必须
├─ shop_total_amount_cost	number	必须		按原价计算当前店铺的购物车总金额
├─ shop_total_amount	number	必须		店铺购物车总金额
├─ shop_total_packing_fee	number	必须		包装费
├─ goods_amount	number	必须		购物车总金额
├─ goods_amount_cost	number	必须		按原价计算购物总金额
├─ buyer_id	string	必须		买家ID

添加商品至购物车

基本信息

Path： /goods/cart/add

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
chain_id	string	非必须		传播链ID
goods_id	string	必须		商品ID
goods_num	integer	必须		商品数量	format: int32
spec_param	object []	非必须		商品规格组合	item 类型: object
├─ spec_id	string	非必须		规格ID
├─ specvalue_name	string	非必须		规格值名称
├─ specvalue_id	string	非必须		规格值ID
├─ spec_name	string	非必须		规格名称
app_id	string	非必须
extend_info	string	非必须		购物车扩展信息
pkg_group	object []	必须		套餐情况	item 类型: object
├─ group_name	string	必须		分组名称
├─ goods_num	string	必须		分组中规定个数
├─ goods_list	string	必须		商品id列表

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_details	object []	必须		店铺购物车详情	item 类型: object
├─ store_id	string	必须		店铺ID
├─ store_state	integer	非必须			format: int32
├─ store_goods_amount	integer	必须		店铺商品购买数量	format: int32
├─ store_name	string	必须		店铺名称
├─ store_cart_list	object []	必须		店铺购物车列表	item 类型: object
├─ store_id	string	非必须
├─ goods_name	string	必须		商品名称
├─ chain_id	string	必须		传播链ID
├─ specparam_name	string	必须		商品规格名称
├─ goods_price	number	必须		商品价格
├─ goods_storage	integer	非必须			format: int32
├─ goods_id	string	必须		商品ID
├─ buyer_id	string	非必须
├─ extend_info	string	必须		扩展信息
├─ image_path	string	必须		商品图片
├─ specparam_id	string	必须		商品规格ID
├─ goods_discount	number	必须		商品折扣
├─ goods_num	integer	必须		商品购买数量	format: int32
├─ goods_state	string	必须		商品状态
├─ store_name	string	非必须
├─ id	string	必须		购物车ID
├─ app_id	string	必须		应用ID
├─ goods_storage_check	string	必须		是否验证库存：0验证 1不验证
├─ goods_pkg	object []	必须			item 类型: object
├─ discount_amount	number	必须		优惠金额
├─ max	number	必须		最大价格
├─ min	number	必须		最小价格
├─ pkg_goods	object	必须		套餐内分组
├─ goods_num	integer	必须		限制数量
├─ group_name	string	必须		分组名称
├─ pkg_goods	object []	必须		具体商品情况	item 类型: object
├─ goods_discount	number	必须		商品折扣
├─ goods_id	string	必须		商品id
├─ goods_name	string	必须		商品名称
├─ goods_price	number	必须		商品价格
├─ goods_state	integer	必须		商品状态 商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_storage_check	integer	必须		是否验证库存：0验证 1不验证
├─ image_path	string	必须		商品默认图片
├─ goods_storage	integer	必须		商品库存
├─ shop_total_amount_cost	number	必须		按原价计算当前店铺的购物车总金额
├─ shop_total_amount	number	必须		店铺购物车总金额
├─ goods_amount	number	必须		购物车总金额
├─ goods_amount_cost	number	必须		按原价计算购物总金额
├─ buyer_id	string	必须		买家ID

删除购物车中商品

基本信息

Path： /goods/cart/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
cart_ids	string []	必须		购物车ID列表	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

按店铺清空买家购物车（按角色）

基本信息

Path： /goods/cart/cleanCartsOfStoreByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
member_id	string	必须		会员ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

按店铺清空买家购物车

基本信息

Path： /goods/cart/cleanCartsOfStore

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新购物车中商品数量

基本信息

Path： /goods/cart/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
cart_id	string	必须		购物车ID
goods_num	integer	必须		商品数量	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询买家购物车列表

基本信息

Path： /goods/cart/query

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须		店铺ID
app_id	string	必须		应用ID
cart_ids	string []	必须		购物车id列表	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_details	object []	必须		店铺购物车详情	item 类型: object
├─ store_id	string	必须		店铺ID
├─ store_state	integer	非必须			format: int32
├─ store_goods_amount	integer	必须		店铺商品购买数量	format: int32
├─ store_name	string	必须		店铺名称
├─ store_cart_list	object []	必须		店铺购物车列表	item 类型: object
├─ store_id	string	非必须
├─ goods_name	string	必须		商品名称
├─ chain_id	string	必须		传播链ID
├─ specparam_name	string	必须		商品规格名称
├─ goods_price	number	必须		商品价格
├─ goods_storage	integer	非必须			format: int32
├─ goods_id	string	必须		商品ID
├─ buyer_id	string	非必须
├─ extend_info	string	必须		扩展信息
├─ image_path	string	必须		商品图片
├─ specparam_id	string	必须		商品规格ID
├─ goods_discount	number	必须		商品折扣
├─ goods_num	integer	必须		商品购买数量	format: int32
├─ goods_state	string	必须		商品状态
├─ store_name	string	非必须
├─ id	string	必须		购物车ID
├─ app_id	string	必须		应用ID
├─ need_matching	integer	必须		撮合开关 0=关，1=开
├─ shop_total_amount_cost	number	必须		按原价计算当前店铺的购物车总金额
├─ shop_total_amount	number	必须		店铺购物车总金额
├─ goods_amount	number	必须		购物车总金额
├─ goods_amount_cost	number	必须		按原价计算购物总金额
├─ buyer_id	string	必须		买家ID

查询买家购物车列表（按角色）

基本信息

Path： /goods/cart/queryByRole

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须		店铺ID
app_id	string	必须		应用ID
member_id	string	必须		会员ID
cart_ids	string []	必须		购物车id列表	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_details	object []	必须		店铺购物车详情	item 类型: object
├─ store_id	string	必须		店铺ID
├─ store_state	integer	非必须			format: int32
├─ store_goods_amount	integer	必须		店铺商品购买数量	format: int32
├─ store_name	string	必须		店铺名称
├─ store_cart_list	object []	必须		店铺购物车列表	item 类型: object
├─ store_id	string	非必须
├─ goods_name	string	必须		商品名称
├─ chain_id	string	必须		传播链ID
├─ specparam_name	string	必须		商品规格名称
├─ goods_price	number	必须		商品价格
├─ goods_storage	integer	非必须			format: int32
├─ goods_id	string	必须		商品ID
├─ buyer_id	string	非必须
├─ extend_info	string	必须		扩展信息
├─ image_path	string	必须		商品图片
├─ specparam_id	string	必须		商品规格ID
├─ goods_discount	number	必须		商品折扣
├─ goods_num	integer	必须		商品购买数量	format: int32
├─ goods_state	string	必须		商品状态
├─ store_name	string	非必须
├─ id	string	必须		购物车ID
├─ app_id	string	必须		应用ID
├─ shop_total_amount_cost	number	必须		按原价计算当前店铺的购物车总金额
├─ shop_total_amount	number	必须		店铺购物车总金额
├─ goods_amount	number	必须		购物车总金额
├─ goods_amount_cost	number	必须		按原价计算购物总金额
├─ buyer_id	string	必须		买家ID

获取买家购物车中的商品件数

基本信息

Path： /goods/cart/getCartCount

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须		店铺ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ total_cart_count	integer	非必须			format: int64

查询购物车扩展信息

基本信息

Path： /goods/cart/getCartExtendInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
spec_param	object []	非必须		规格参数组合列表	item 类型: object
├─ spec_id	string	非必须		规格ID
├─ specvalue_name	string	非必须		规格值名称
├─ specvalue_id	string	非必须		规格值ID
├─ spec_name	string	非必须		规格名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ cart_id	string	必须		购物车ID
├─ extend_info	string	必须		扩展信息

商品服务（goods）-应用扩展信息管理

修改应用商品分类扩展配置

基本信息

Path： /goods/extend/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
templatesetting	object []	必须		扩展模板	item 类型: object
├─ template_url	string	必须		模板URL
├─ area_id	string	必须		区域ID
mall_gc_id	string	必须		应用商品分类ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

按应用商品分类移除扩展配置

基本信息

Path： /goods/extend/remove

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
mall_gc_id	string	必须		应用商品分类ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

按应用商品分类查询扩展配置

基本信息

Path： /goods/extend/find

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
mall_gc_id	string	必须		应用商品分类ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ templatesetting	object []	必须		扩展模板	item 类型: object
├─ template_url	string	必须		模板URL
├─ area_id	string	必须		区域ID
├─ parent	boolean	必须		当前扩展配置是否属于父分类
├─ exists	boolean	必须		当前商品分类是否存在扩展配置

根据商品分类查询扩展配置

基本信息

Path： /goods/extend/public/findByGoodsclass

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
gc_id	string	必须		商品分类ID
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ templatesetting	object []	必须		扩展模板	item 类型: object
├─ template_url	string	必须		模板URL
├─ area_id	string	必须		区域ID
├─ parent	boolean	必须		当前扩展配置是否属于父分类
├─ exists	boolean	必须		当前商品分类是否存在扩展配置

根据商品ID查询扩展模板设置

基本信息

Path： /goods/extend/public/findByGoodsIds

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_ids	string []	必须		商品ID数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ goods_id	string	必须		商品ID
├─ extend_template	object	必须
├─ templatesetting	object []	必须		扩展模板	item 类型: object
├─ template_url	string	必须		模板URL
├─ area_id	string	必须		区域ID
├─ parent	boolean	必须		当前扩展配置是否属于父分类
├─ exists	boolean	必须		当前商品分类是否存在扩展配置

商品服务（goods）-商品扩展信息管理

更新商品扩展信息

基本信息

Path： /goods/goods/updateGoodsExtendInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
extend_info	string	必须		商品扩展信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

获取商品扩展信息

基本信息

Path： /goods/goods/getGoodsExtendInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ goods_id	string	必须		商品ID
├─ extend_info	string	必须		商品扩展信息

商品服务（goods）-商品分组管理

新增商品分组

基本信息

Path： /goods/goods/createGoodsGroup

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
storegc_name	string	必须		店铺商品分类名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

更新商品分组

基本信息

Path： /goods/goods/updateGoodsGroup

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		商品分组ID
storegc_name	string	必须		商品分组名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除（批量删除）商品分组

基本信息

Path： /goods/goods/deleteGoodsGroup

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
storegc_ids	string []	必须		商品分组ID数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询所有商品分组（下拉框使用）

基本信息

Path： /goods/goods/findAllGoodsGroup

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ storegc_id	string	必须		商品分组ID
├─ storegc_name	string	必须		商品分组名称

分页查询所有商品分组

基本信息

Path： /goods/goods/findGoodsGroup

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
storegc_name	string	非必须		分组名称
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

根据分组ID获取商品分组详情

基本信息

Path： /goods/goods/getGoodsGroup

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
storegc_id	string	必须		商品分组ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ storegc_id	string	必须		商品分组ID
├─ storegc_name	string	必须		商品分组名称

商品服务（goods）-商品所属分组管理

编辑商品关联的店铺分类

基本信息

Path： /goods/goodsclass/updateBoundClasses

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
del_gcids	string []	非必须		删除的店铺分类	item 类型: string
├─		非必须
new_gcids	string []	非必须		新增的店铺分类	item 类型: string
├─		非必须
goods_id	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询商品关联的店铺分类

基本信息

Path： /goods/goodsclass/goodsBoundClasses

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
goods_id	string	必须		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ goods_class	object []	必须		店铺分类信息	item 类型: object
├─ store_id	string	必须		店铺ID
├─ children	[]	必须		当前分类的子分类
├─		非必须
├─ level	integer	必须		树型结构层级，使用数字表示	format: int32
├─ checked	boolean	必须		商品是否已绑定 当前分类
├─ id	string	必须		分类ID
├─ sort	integer	必须		分类排序	format: int32
├─ storegc_name	string	必须		分类名称
├─ storegc_parent_id	string	非必须

商品服务（goods）-商品分类ES管理

同步全部商品分类数据到ES

基本信息

Path： /goods/goodsclasses/saveAll

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

同步某个商品分类到ES

基本信息

Path： /goods/goodsclasses/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

删除全部ES商品分类

基本信息

Path： /goods/goodsclasses/deleteAll

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除某个ES商品分类

基本信息

Path： /goods/goodsclasses/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		分类ID
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

根据商品id查询某个ES商品分类

基本信息

Path： /goods/goodsclasses/find

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Query

参数名称	是否必须	示例	备注
appId	否
id	否		商品分类id
Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须			format: binary

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ gc_show	integer	必须		商品分类前台显示 0:否 1:是	format: int32
├─ gc_sort	integer	必须		商品分类排序	format: int32
├─ goodsclass_id	string	必须		商品分类id
├─ gc_type_id	string	非必须
├─ level	integer	必须		树型结构层级，使用数字表示	format: int32
├─ gc_full_path	string	必须		分类完整路径
├─ gc_app_id	string	非必须
├─ gc_status	integer	必须		商品分类状态	format: int32
├─ result	string	必须		审核结果
├─ gc_name	string	必须		分类名
├─ gc_virtual	integer	必须		是否允许发布虚拟商品 1:是 0:否	format: int32
├─ id	string	必须		商品分类ESid
├─ gc_parent_id	string	必须		父分类id

商品服务（goods）-商品ES管理

同步全部商品数据到ES

基本信息

Path： /goods/goodses/saveAll

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

同步某个商品到ES

基本信息

Path： /goods/goodses/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

删除全部ES商品

基本信息

Path： /goods/goodses/deleteAll

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除某个ES商品

基本信息

Path： /goods/goodses/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询店铺的商品列表（不分页）（ES）

基本信息

Path： /goods/goodses/public/queryGoodsByStore

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须		店铺ID
goods_name	string	非必须		商品名称或关键字
gc_id	string	非必须		商品分类ID
goods_advword	string	非必须
sort	string	非必须		排序规则
price_min	number	非必须
price_max	number	非必须
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ ref_id	string	必须		应用关联商品ID
├─ goods_name	string	必须		商品名称
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		分类ID
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_discount	number	非必须		商品折扣
├─ goods_id	string	必须		商品ID
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_discount_price	number	必须		商品折后价

根据名字搜索ES商品

基本信息

Path： /goods/goodses/public/searchbyname

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Query

参数名称	是否必须	示例	备注
name	否		搜索的字段
pageNo	否
pageSize	否
sort	否		分页的方式
sortFiled	否
Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须			format: binary

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ is_virtual	integer	必须		是否为虚拟商品 1:是 0:否	format: int32
├─ ref_id	string	必须		应用关联商品ID
├─ store_es_id	string	必须		商品店铺ESid
├─ gc_fullpath	string	必须		商品分类完整路径冗余，方便按分类或子分类查询商品
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		商品分类id
├─ goods_storage	integer	必须		总库存	format: int32
├─ evaluation_count	integer	必须		评价数	format: int64
├─ goods_costprice	number	必须		商品成本价
├─ price_min	number	必须		最低价
├─ extend_info	string	必须		扩展信息JSON
├─ goods_salenum	integer	必须		销量	format: int64
├─ goods_discount	number	必须		商品折扣
├─ id	string	必须		商品ESid
├─ goodsattrindexes	object []	必须		商品属性	item 类型: object
├─ attrvalue_id	string	非必须
├─ attr_id	string	必须		属性id
├─ goods_shelftime	object	必须
├─ date	integer	非必须			format: int32
├─ hours	integer	非必须			format: int32
├─ seconds	integer	非必须			format: int32
├─ month	integer	非必须			format: int32
├─ nanos	integer	非必须			format: int32
├─ year	integer	非必须			format: int32
├─ minutes	integer	非必须			format: int32
├─ timezone_offset	integer	非必须			format: int32
├─ time	integer	非必须			format: int64
├─ day	integer	非必须			format: int32
├─ goods_name	string	必须		商品名称
├─ goods_vat	integer	必须		商品是否开具增值税发票 1:是 0:否	format: int32
├─ type_id	string	必须		类型id
├─ good_app_id	string	必须		商品应用id
├─ goods_advword	string	必须		商品广告词
├─ goods_id	string	必须		商品id
├─ goods_desc	string	必须		商品描述
├─ good_store_id	string	非必须
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goodsimages_pojos	object []	必须		图片	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		文件路径
├─ id	string	非必须
├─ sort	integer	必须		商品图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ brand_id	string	必须		品牌id
├─ goods_freight	number	必须		商品运费 0为免运费
├─ goods_serial	string	必须		商品编号
├─ image_path	string	必须		默认图片路径
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_addtime	object	必须
├─ date	integer	非必须			format: int32
├─ hours	integer	非必须			format: int32
├─ seconds	integer	非必须			format: int32
├─ month	integer	非必须			format: int32
├─ nanos	integer	非必须			format: int32
├─ year	integer	非必须			format: int32
├─ minutes	integer	非必须			format: int32
├─ timezone_offset	integer	非必须			format: int32
├─ time	integer	非必须			format: int64
├─ day	integer	非必须			format: int32
├─ spec_value	string	必须		规格值
├─ goods_marketprice	number	必须		商品市场价
├─ price_max	number	必须		最高价

根据商品id查询某个ES商品

基本信息

Path： /goods/goodses/public/find

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Query

参数名称	是否必须	示例	备注
goodsId	否
hasRole	否
userId	否
Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须			format: binary

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ is_virtual	integer	必须		是否为虚拟商品 1:是 0:否	format: int32
├─ ref_id	string	必须		应用关联商品ID
├─ store_es_id	string	必须		商品店铺ESid
├─ gc_fullpath	string	必须		商品分类完整路径冗余，方便按分类或子分类查询商品
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		商品分类id
├─ goods_storage	integer	必须		总库存	format: int32
├─ evaluation_count	integer	必须		评价数	format: int64
├─ goods_costprice	number	必须		商品成本价
├─ price_min	number	必须		最低价
├─ extend_info	string	必须		扩展信息JSON
├─ goods_salenum	integer	必须		销量	format: int64
├─ goods_discount	number	必须		商品折扣
├─ id	string	必须		商品ESid
├─ goodsattrindexes	object []	必须		商品属性	item 类型: object
├─ attrvalue_id	string	非必须
├─ attr_id	string	必须		属性id
├─ goods_shelftime	object	必须
├─ date	integer	非必须			format: int32
├─ hours	integer	非必须			format: int32
├─ seconds	integer	非必须			format: int32
├─ month	integer	非必须			format: int32
├─ nanos	integer	非必须			format: int32
├─ year	integer	非必须			format: int32
├─ minutes	integer	非必须			format: int32
├─ timezone_offset	integer	非必须			format: int32
├─ time	integer	非必须			format: int64
├─ day	integer	非必须			format: int32
├─ goods_name	string	必须		商品名称
├─ goods_vat	integer	必须		商品是否开具增值税发票 1:是 0:否	format: int32
├─ type_id	string	必须		类型id
├─ good_app_id	string	必须		商品应用id
├─ goods_advword	string	必须		商品广告词
├─ goods_id	string	必须		商品id
├─ goods_desc	string	必须		商品描述
├─ good_store_id	string	非必须
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goodsimages_pojos	object []	必须		图片	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		文件路径
├─ id	string	非必须
├─ sort	integer	必须		商品图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ brand_id	string	必须		品牌id
├─ goods_freight	number	必须		商品运费 0为免运费
├─ goods_serial	string	必须		商品编号
├─ image_path	string	必须		默认图片路径
├─ goods_state	string	必须		商品状态 0:下架 1:正常 10:违规（禁售）2:编辑
├─ goods_addtime	object	必须
├─ date	integer	非必须			format: int32
├─ hours	integer	非必须			format: int32
├─ seconds	integer	非必须			format: int32
├─ month	integer	非必须			format: int32
├─ nanos	integer	非必须			format: int32
├─ year	integer	非必须			format: int32
├─ minutes	integer	非必须			format: int32
├─ timezone_offset	integer	非必须			format: int32
├─ time	integer	非必须			format: int64
├─ day	integer	非必须			format: int32
├─ spec_value	string	必须		规格值
├─ goods_marketprice	number	必须		商品市场价
├─ price_max	number	必须		最高价

店铺首页商品搜索（V0.8）

基本信息

Path： /goods/goodses/public/queryHomePageInStore

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
keywords	string	非必须		关键字
store_id	string	必须		店铺ID
storegc_id	string	非必须		商品分类ID
order	string	非必须		排序字段
sort	string	非必须		正序/倒序：asc/desc
pageno	integer	必须		页数
pagesize	integer	必须		每页记录数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object []	非必须			item 类型: object
├─ goods_id	string	非必须		商品ID
├─ image_path	string	非必须		商品默认图片
├─ goods_name	string	非必须		商品名称
├─ goods_price	number	非必须		商品价格
├─ goods_salenum	number	非必须		商品销量
├─ favorable_rate	number	非必须		好评率
├─ goods_desc	string	必须		商品描述
page	object	非必须
├─ pageno	number	非必须
├─ pagesize	number	非必须
├─ records	number	非必须
├─ total	number	非必须

商城首页商品搜索（ES）

基本信息

Path： /goods/goodses/public/queryIndex

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	非必须
goods_name	string	非必须		商品名称或关键字
type_id	string	非必须		商品类型ID
gc_id	string	非必须		商品分类ID
goods_advword	string	非必须
sort	string	非必须		排序规则
area_id	string	非必须		区域ID
price_min	number	必须		最小价格
attrs	object []	非必须		商品属性组	item 类型: object
├─ attrvalues	string []	非必须		属性值ID组	item 类型: string
├─		非必须
├─ attr_id	string	非必须		属性ID
brand_id	string	非必须		品牌ID
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
goods_state	string	非必须		商品状态
store_name	string	非必须		店铺名称
app_id	string	必须		应用ID
price_max	number	必须		最大价格
city_id	string	非必须		城市ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ ref_id	string	必须		应用关联商品ID
├─ store_id	string	必须		店铺ID
├─ goods_name	string	必须		商品名称
├─ goods_price	number	必须		商品价格
├─ gc_id	string	非必须
├─ goods_advword	string	非必须
├─ goods_id	string	必须		商品ID
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_commend	integer	必须		商品推荐 1:是 0:否	format: int32
├─ goods_discount_price	number	非必须		商品折后价
├─ goods_salenum	integer	必须		销量	format: int64
├─ goods_image	string	必须		商品默认图片
├─ goods_discount	number	必须		商品折扣
├─ store_name	string	必须		店铺名称
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

获取电子菜谱对应的点餐单（包含店铺信息）（ES）

基本信息

Path： /goods/goodses/public/queryGoodsByRef

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
distance	number	必须		搜索距离范围（米）	format: double
ref_ids	string []	必须		电子菜谱ID数组	item 类型: string
├─		非必须
gc_id	string	必须		商品分类ID
latitude	number	必须		目标纬度	format: double
area_id	string	非必须		区域ID
city_id	string	非必须		城市ID
longitude	number	必须		目标经度	format: double

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ ref_id	string	必须		电子菜谱商品ID
├─ ref_name	string	必须		电子菜谱商品名称
├─ store_infos	object []	必须		店铺商品信息	item 类型: object
├─ ref_id	string	必须		电子菜谱ID
├─ goods_name	string	必须		商品名称
├─ store_info	object	必须
├─ store_id	string	必须		店铺ID
├─ distance	number	必须		与店铺距离（米）	format: double
├─ is_open	integer	必须		是否营业：0休息1营业中	format: int32
├─ store_logo	string	必须		店铺LOGO
├─ store_name	string	必须		店铺名称
├─ store_workingtime	string	必须		店铺营业时间
├─ goods_image	object []	必须		商品图片组	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32
├─ goods_price	number	必须		商品价格
├─ gc_id	string	必须		分类ID
├─ goods_storage	integer	必须		商品库存	format: int32
├─ goods_discount	number	必须		商品折扣
├─ goods_id	string	必须		商品ID
├─ goods_desc	string	必须		商品描述
├─ extend_info	string	必须		扩展信息
├─ goods_discount_price	number	必须		商品折后价
├─ ref_image	object []	必须		电子菜谱商品图片	item 类型: object
├─ file_type	integer	必须		文件类型：1图片2视频	format: int32
├─ image_path	string	必须		图片路径
├─ id	string	必须		图片ID
├─ sort	integer	必须		图片排序	format: int32
├─ is_default	integer	必须		商品图片默认主图，1是，0否	format: int32

商品服务（goods）-商品类型管理

新增商品类型

基本信息

Path： /goods/goodstype/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
type_name	string	必须		商品类型名称
id	string	非必须		类型ID
sort	integer	必须		商品类型排序	format: int32
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

更新商品类型

基本信息

Path： /goods/goodstype/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
type_name	string	必须		当前商品类型
id	string	必须		当前商品类型ID
sort	integer	必须		商品排序	format: int32
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

新建商品类型（级联创建，包括属性、值）

基本信息

Path： /goods/goodstype/addAttrAndValues

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_info	object []	必须		关联属性	item 类型: object
├─ create_time	string	非必须		创建时间	format: date-time
├─ attr_name	string	必须		属性名称
├─ attr_type	integer	必须		属性类别	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
type_name	string	必须		类型名称
id	string	非必须
sort	integer	必须		类型排序	format: int32
app_id	string	必须		应用ID，在这里必填。如果是系统分类请使用其他接口

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

更新商品类型（级联更新，包括属性、值）

基本信息

Path： /goods/goodstype/updateTypeAttrValues

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_info	object []	必须		属性信息	item 类型: object
├─ create_time	string	非必须		创建时间	format: date-time
├─ attr_name	string	必须		属性名称
├─ attr_type	integer	必须		属性类别	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
type_name	string	必须		类型名称
id	string	必须		类型ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

应用申请商品分类和添加自定义类型

基本信息

Path： /goods/goodstype/saveClassAndType

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_class	object	必须
├─ gc_name	string	必须		商品分类名称
├─ type_id	string	非必须		类型id
├─ sort	integer	必须		商品分类排序	format: int32
├─ app_id	string	非必须		应用ID
├─ gc_parent_id	string	非必须		商品分类上级ID
goods_type	object	必须
├─ attr_info	object []	必须		关联属性	item 类型: object
├─ create_time	string	非必须		创建时间	format: date-time
├─ attr_name	string	必须		属性名称
├─ attr_type	integer	必须		属性类别	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
├─ type_name	string	必须		类型名称
├─ id	string	非必须
├─ sort	integer	必须		类型排序	format: int32
├─ app_id	string	必须		应用ID，在这里必填。如果是系统分类请使用其他接口

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

删除（批量删除）商品类型

基本信息

Path： /goods/goodstype/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
delete_ids	string []	必须		商品类型ID数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询商品类型列表（分页查询）

基本信息

Path： /goods/goodstype/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
type_name	string	非必须		类型名称
pageno	integer	必须		页数	format: int32
pagesize	integer	非必须			format: int32
sort	string	非必须		排序规则
app_id	string	非必须		应用ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ type_name	string	必须		类型名称
├─ create_time	string	必须		创建时间	format: date-time
├─ id	string	必须		商品类型ID
├─ sort	integer	必须		类型排序大小	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询所有的商品类型

基本信息

Path： /goods/goodstype/findAllGoodsType

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ type_name	string	必须		类型名称
├─ create_time	string	必须		创建时间	format: date-time
├─ id	string	必须		商品类型ID
├─ sort	integer	必须		类型排序大小	format: int32

获取商品类型详情

基本信息

Path： /goods/goodstype/get

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goodstype_id	string	必须		商品类型ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ type_name	string	必须		商品类型名称
├─ id	string	非必须		类型ID
├─ sort	integer	必须		商品类型排序	format: int32
├─ app_id	string	非必须		应用ID

查询商品类型及关联的属性信息

基本信息

Path： /goods/goodstype/getDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须		排序规则
goodstype_id	string	必须		商品类型ID
order	string	非必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ create_time	string	非必须		创建时间	format: date-time
├─ attr_name	string	必须		属性名称
├─ attr_type	integer	必须		属性类别	format: int32
├─ sort	integer	必须		属性排序	format: int32
├─ attr_values	object []	必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

商品服务（goods）-商品属性管理

添加商品类型属性（包括值信息）

基本信息

Path： /goods/goodsAttr/addAttrAndValues

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_name	string	必须		属性名称
type_id	string	必须		类型ID
attr_type	integer	必须		属性类别1选择类型2手动输入类型	format: int32
sort	integer	必须		属性排序	format: int32
attr_values	object []	非必须		属性值信息	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

修改商品类型属性信息

基本信息

Path： /goods/goodsAttr/updateAttrInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_name	string	必须		属性名称
delete_ids	string []	非必须		删除的属性值ID列表	item 类型: string
├─		非必须
type_id	string	必须		所属类型id
attr_type	integer	必须		属性类别1选择类型2手动输入类型	format: int32
update_list	object []	非必须		更新的属性值列表	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
id	string	必须		属性ID
sort	integer	必须		属性排序	format: int32
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

更新系统属性关联自定义属性值

基本信息

Path： /goods/goodsAttr/updateSystemAttrvalues

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
delete_ids	string []	非必须		删除的属性值ID列表	item 类型: string
├─		非必须
update_list	object []	非必须		更新的属性值列表	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
id	string	必须		属性ID
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除或批量删除商品类型属性

基本信息

Path： /goods/goodsAttr/deleteTypeAttr

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_ids	string []	必须		属性ID集合	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

新增商品属性

基本信息

Path： /goods/goodsAttr/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_name	string	必须		属性名称
type_id	string	必须		所属类型ID
attr_type	integer	必须		属性类别	format: int32
sort	integer	必须		属性排序	format: int32
app_id	string	非必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

更新商品属性

基本信息

Path： /goods/goodsAttr/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_name	string	必须		属性名称
type_id	string	必须		所属类型ID
attr_type	integer	必须		属性类别1选择类型2手动输入类型	format: int32
id	string	必须		属性ID
sort	integer	必须		属性排序	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除商品属性

基本信息

Path： /goods/goodsAttr/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_id	string	必须		属性ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询所有的商品属性

基本信息

Path： /goods/goodsAttr/findAllPage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	非必须
app_id	string	非必须		应用ID
order	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ type_name	string	必须		类型名称
├─ attr_name	string	必须		属性名称
├─ type_id	string	必须		所属类型id
├─ attr_type	integer	必须		属性类别1选择类型2手动输入类型	format: int32
├─ id	string	必须		属性ID
├─ sort	integer	必须		属性排序	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询商品属性详情

基本信息

Path： /goods/goodsAttr/getDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_id	string	必须		属性ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ attr_name	string	必须		属性名称
├─ type_id	string	必须		所属类型ID
├─ id	string	必须		属性ID
├─ sort	integer	必须		属性排序	format: int32

新增商品属性值

基本信息

Path： /goods/goodsAttrValue/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
sort	integer	必须		排序大小	format: int32
attrvalue_name	string	必须		属性值名称
app_id	string	非必须		应用ID
attr_id	string	必须		属性ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

更新商品属性值

基本信息

Path： /goods/goodsAttrValue/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		实体 ID
sort	integer	必须		属性值排序	format: int32
attrvalue_name	string	必须		属性值名称
attr_id	string	必须		所属属性id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除商品属性值

基本信息

Path： /goods/goodsAttrValue/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attrvalue_id	string	必须		属性值ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询所有的商品属性值

基本信息

Path： /goods/goodsAttrValue/findAllPage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
attr_id	string	必须		属性ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ attr_name	string	必须		属性名称
├─ id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询商品属性值详情

基本信息

Path： /goods/goodsAttrValue/getDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attrvalue_id	string	必须		属性值ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ attr_name	string	必须		属性名称
├─ id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID

更新商品属性关联的商品属性值

基本信息

Path： /goods/goodsAttrValue/updateAttrValue

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
attr_values	object []	必须		属性值列表	item 类型: object
├─ attr_name	string	必须		属性名称
├─ id	string	必须		属性值ID
├─ sort	integer	必须		属性值排序	format: int32
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID
attr_id	string	必须		所属属性id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

商品服务（goods）-商品关联属性管理

更新商品关联属性

基本信息

Path： /goods/goods/updateGoodsAttr

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
attr	object []	非必须		商品关联属性组	item 类型: object
├─ attrvalue_id	string []	非必须		属性值ID数组	item 类型: string
├─		非必须
├─ attr_id	string	必须		属性ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

获取商品关联属性

基本信息

Path： /goods/goods/queryGoodsAttr

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ goods_attr	object []	必须		商品属性组	item 类型: object
├─ attr_name	string	必须		属性名称
├─ attrvalue	object []	必须		属性值组	item 类型: object
├─ attrvalue_id	string	必须		属性值ID
├─ is_checked	string	必须		属性值是否选中
├─ attrvalue_name	string	必须		属性值名称
├─ attr_id	string	必须		属性ID

商品服务（goods）-商品规格管理

添加商品规格

基本信息

Path： /goods/goodsSpec/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
sp_name	string	必须		规格名称
type_id	string	必须		所属类型id
sort	integer	必须		规格排序	format: int32
app_id	string	必须		应用ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

更新商品规格

基本信息

Path： /goods/goodsSpec/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
sp_name	string	非必须		规格名称
type_id	string	非必须		所属类型id
id	string	非必须		规格ID
sort	integer	非必须		规格排序	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除商品规格

基本信息

Path： /goods/goodsSpec/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
spec_id	string	必须		规格ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询所有的商品规格

基本信息

Path： /goods/goodsSpec/findAllPage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	必须		排序方式
app_id	string	必须		应用ID
order	string	必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应状态信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ sp_name	string	必须		规格名称
├─ type_id	string	必须		所属类型ID
├─ id	string	必须		规格ID
├─ sort	integer	必须		规格排序	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询商品规格详情

基本信息

Path： /goods/goodsSpec/getDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
spec_id	string	必须		规格ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ sp_name	string	必须		规格名称
├─ type_id	string	必须		所属类型ID
├─ id	string	必须		规格ID
├─ sort	integer	必须		规格排序	format: int32

批量添加商品规格值

基本信息

Path： /goods/goodsSpecValue/batchAdd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
spec_values	object []	必须		规格值列表	item 类型: object
├─ spvalue_name	string	必须		规格值名称
├─ sort	integer	必须		规格值排序	format: int32
sp_id	string	必须		所属规格ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ specvalue_ids	string []	必须		批量添加的规格值ID	item 类型: string
├─		非必须

添加商品规格值

基本信息

Path： /goods/goodsSpecValue/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
sp_id	string	必须		所属规格ID
spvalue_name	string	必须		规格值名称
sort	integer	必须		规格排序	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

更新商品规格值

基本信息

Path： /goods/goodsSpecValue/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
sp_id	string	必须		所属规格ID
spvalue_name	string	必须		规格值名称
id	string	必须		规格值ID
sort	integer	必须		规格排序	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

批量更新商品规格下的规格值

基本信息

Path： /goods/goodsSpecValue/updateSpecValue

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
spec_values	object []	必须		规格值列表	item 类型: object
├─ spvalue_name	string	必须		规格值名称
├─ sort	integer	必须		规格值排序	format: int32
sp_id	string	必须		所属规格ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

删除商品规格值

基本信息

Path： /goods/goodsSpecValue/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
spvalue_id	string	非必须		当前规格值ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询所有的商品规格值

基本信息

Path： /goods/goodsSpecValue/findAllPage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
sp_id	string	必须		规格ID
pageno	integer	必须		当前页码数	format: int32
pagesize	integer	必须		每页的记录数	format: int32
sort	string	必须		排序方式
order	string	必须		排序字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ store_id	string	必须		店铺ID
├─ sp_id	string	必须		所属规格ID
├─ spvalue_name	string	必须		规格值名称
├─ id	string	必须		规格值ID
├─ sort	integer	必须		规格值排序	format: int32
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

查询商品规格值详情

基本信息

Path： /goods/goodsSpecValue/getDetail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
spvalue_id	string	非必须		当前规格值ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_id	string	必须		店铺ID
├─ sp_id	string	必须		所属规格ID
├─ spvalue_name	string	必须		规格值名称
├─ id	string	必须		规格值ID
├─ sort	integer	必须		规格值排序	format: int32

商品服务（goods）-商品关联规格管理

更新商品关联规格信息

基本信息

Path： /goods/goods/updateGoodsSpec

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
sp_name	string	非必须		规格名称
type_id	string	非必须		所属类型id
id	string	非必须		规格ID
sort	integer	非必须		规格排序	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询商品所有规格和规格值

基本信息

Path： /goods/goods/queryAllGoodsSpec

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
has_role	boolean	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ goods_spec	object []	必须		商品规格组	item 类型: object
├─ spec_id	string	必须		规格ID
├─ spec_name	string	必须		规格名称
├─ specvalues	object []	必须		规格值组	item 类型: object
├─ specvalue_name	string	必须		规格值名称
├─ is_checked	string	必须		规格值是否选中
├─ specvalue_id	string	必须		规格值ID

商品服务（goods）-品牌管理

新增或更新品牌

基本信息

Path： /goods/brand/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
store_id	string	必须		店铺ID
brand_apply	integer	必须		品牌申请，0为申请中，1为通过，默认为1，申请功能是会员使用	format: int32
brand_showtype	integer	必须		品牌展示类型	format: int32
brand_initial	string	必须		品牌首字母
brand_name	string	必须		品牌名称
brand_pic	string	必须		品牌图片
sort	integer	必须		品牌排序	format: int32
brand_recommend	integer	必须		品牌推荐，0为否，1为是	format: int32
brand_id	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ id	string	必须		商品ID

删除品牌

基本信息

Path： /goods/brand/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
brand_id	string	必须		品牌ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	非必须		响应数据

查询品牌列表

基本信息

Path： /goods/brand/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		当前页数	format: int32
pagesize	integer	必须		每页的记录数	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object []	必须		响应数据	item 类型: object
├─ store_id	string	必须		店铺ID
├─ brand_apply	integer	必须		品牌申请，0为申请中，1为通过，默认为1，申请功能是会员使用	format: int32
├─ brand_showtype	integer	必须		品牌展示类型	format: int32
├─ brand_initial	string	必须		品牌首字母
├─ brand_name	string	必须		品牌名称
├─ brand_pic	string	必须		品牌图片
├─ sort	integer	必须		品牌排序	format: int32
├─ brand_recommend	integer	必须		品牌推荐，0为否，1为是	format: int32
├─ brand_id	string	非必须
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

获取品牌信息

基本信息

Path： /goods/brand/get

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
brand_id	string	必须		品牌ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须		响应信息
code	integer	必须		响应状态码	format: int32
data	object	必须
├─ store_id	string	必须		店铺ID
├─ brand_apply	integer	必须		品牌申请，0为申请中，1为通过，默认为1，申请功能是会员使用	format: int32
├─ brand_showtype	integer	必须		品牌展示类型	format: int32
├─ brand_initial	string	必须		品牌首字母
├─ brand_name	string	必须		品牌名称
├─ brand_pic	string	必须		品牌图片
├─ sort	integer	必须		品牌排序	format: int32
├─ brand_recommend	integer	必须		品牌推荐，0为否，1为是	format: int32
├─ brand_id	string	非必须

商品服务（goods）-商品关注

商品关注/取消关注（V0.8）

基本信息

Path： /goods/goodsfollow/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
goods_id	string	必须		商品ID
type	integer	必须		1：关注，2：取消关注

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须
code	integer	必须			format: int32
data	object	必须
├─ store_id	string	必须		店铺ID
├─ follow_status	integer	必须		关注状态	format: int32
├─ goods_id	string	必须		商品ID

批量取消商品关注（V0.8）

基本信息

Path： /goods/goodsfollow/unfollow/batch

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
	string []	非必须		商品id数组	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

关注的商品列表（V0.8）

基本信息

Path： /goods/goodsfollow/goodsList

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
keywords	string	非必须		关键词
pageno	integer	必须		页数
pagesize	integer	必须		每页记录数
status	integer	必须		查询列表类型（1：有货，2：无货，3：下架）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须
code	integer	必须			format: int32
data	object []	必须			item 类型: object
├─ store_id	string	必须
├─ goods_name	string	必须
├─ follow_count	integer	必须		关注人数	format: int32
├─ goods_price	number	必须		商品价格
├─ image_path	string	必须
├─ goods_id	string	必须
├─ store_name	string	必须
├─ goods_desc	string	必须
page	object	非必须
├─ total	integer	非必须			format: int64
├─ records	integer	非必须			format: int64
├─ pageno	integer	非必须			format: int32
├─ pagesize	integer	非必须			format: int32

用户关注店铺数量和商品数量（V0.8）

基本信息

Path： /goods/goodsfollow/queryUserStoreAndGoodsFollowCount

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
store_follow_count	number	非必须		店铺关注数量
goods_follow_count	number	非必须		商品关注数量

商品服务（goods）-商品关注统计

查询店铺全部商品关注量列表（V0.8）

基本信息

Path： /goods/goodsfollowstat/public/queryStoreAllGoodsfollowstat

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Body

名称	类型	是否必须	默认值	备注	其他信息
pageno	integer	必须		页数
pagesize	integer	必须		记录数
store_id	string	必须		店铺ID
start_time	number	必须		开始日期
end_time	number	必须		结束日期
lower_limit	integer	非必须		最低值
order	string	非必须		排序字段
sort	string	非必须		排序规则

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object []	非必须			item 类型: object
├─ follow_count	number	非必须		关注量
├─ goods_groups	object []	非必须		商品分组	item 类型: object
├─ storegc_id	string	非必须
├─ storegc_name	string	非必须
├─ goods_id	string	非必须		商品ID
├─ goods_name	string	非必须		商品名称
├─ goods_price	number	非必须		商品价格
├─ goods_state	string	非必须		商品状态
page	object	非必须
├─ pageno	number	非必须
├─ pagesize	number	非必须
├─ records	number	非必须
├─ total	number	非必须