Files
full/module/ec/mall/swagger/sample.swagger.json

1282 lines
29 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"swagger": "2.0",
"info": {
"title": "blocks.proto",
"version": "version not set"
},
"tags": [
{
"name": "Ads"
},
{
"name": "Category"
},
{
"name": "Freight"
},
{
"name": "Notice"
},
{
"name": "Product"
},
{
"name": "Staff"
},
{
"name": "Store"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {},
"definitions": {
"mallAdsItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"pos_key": {
"type": "string",
"title": "广告位置"
},
"title": {
"type": "string",
"title": "广告名称"
},
"content": {
"type": "string",
"title": "广告内容"
},
"type": {
"type": "integer",
"format": "int32",
"title": "广告类型 1.文本 2.图片 3.视频"
},
"to_url": {
"type": "string",
"title": "跳转链接"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"status": {
"type": "string",
"format": "int64",
"title": "状态默认为0-1禁止1为正常"
}
}
},
"mallAdsListReply": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallAdsItem"
}
},
"count": {
"type": "string",
"format": "int64"
}
},
"title": "公告列表"
},
"mallCategoriesItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "ID"
},
"identity": {
"type": "string"
},
"title": {
"type": "string",
"title": "名称"
},
"en_title": {
"type": "string",
"title": "英文名称"
},
"parent_id": {
"type": "string",
"format": "int64",
"title": "上级ID"
},
"paths": {
"type": "string",
"title": "路径"
},
"intro": {
"type": "string",
"title": "简介"
},
"icon": {
"type": "string",
"title": "图标"
},
"sort": {
"type": "integer",
"format": "int32",
"title": "排序"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态1-正常2停用"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallCategoriesItem"
},
"title": "子集"
},
"keys": {
"type": "string",
"title": "关键词"
}
}
},
"mallCategoryItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "ID"
},
"identity": {
"type": "string"
},
"title": {
"type": "string",
"title": "名称"
},
"en_title": {
"type": "string",
"title": "英文名称"
},
"parent_id": {
"type": "string",
"format": "int64",
"title": "上级ID"
},
"paths": {
"type": "string",
"title": "路径"
},
"intro": {
"type": "string",
"title": "简介"
},
"icon": {
"type": "string",
"title": "图标"
},
"sort": {
"type": "integer",
"format": "int32",
"title": "排序"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态1-正常2停用"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallCategoryItem"
},
"title": "子集"
},
"keys": {
"type": "string",
"title": "关键词"
}
}
},
"mallCategoryReply": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64",
"title": "数量"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallCategoryItem"
}
}
}
},
"mallCommentItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "ID"
},
"identity": {
"type": "string",
"title": "评论唯一标识"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"nick_name": {
"type": "string",
"title": "用户名称"
},
"score": {
"type": "integer",
"format": "int32",
"title": "评分"
},
"comment": {
"type": "string",
"title": "评论正文"
},
"reply": {
"type": "string",
"title": "回复正文"
},
"product_identity": {
"type": "string",
"title": "所属商品唯一标识"
},
"store_identity": {
"type": "string",
"title": "店铺唯一标识"
},
"spec_identity": {
"type": "string",
"title": "产品规格唯一标识"
},
"comment_identity": {
"type": "string",
"title": "被回复的评论唯一标识"
},
"product": {
"type": "string",
"title": "所属商品"
},
"product_spec": {
"type": "string",
"title": "产品规格"
},
"is_comment": {
"type": "boolean",
"title": "是否是评论"
}
},
"title": "商品评论"
},
"mallCommentItemRep": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "ID"
},
"identity": {
"type": "string",
"title": "评论唯一标识"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"nick_name": {
"type": "string",
"title": "用户名称"
},
"score": {
"type": "integer",
"format": "int32",
"title": "评分"
},
"comment": {
"type": "string",
"title": "评论正文"
},
"reply": {
"type": "string",
"title": "回复正文"
},
"product_identity": {
"type": "string",
"title": "所属商品唯一标识"
},
"store_identity": {
"type": "string",
"title": "店铺唯一标识"
},
"spec_identity": {
"type": "string",
"title": "产品规格唯一标识"
},
"comment_identity": {
"type": "string",
"title": "被回复的评论唯一标识"
},
"list": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallCommentItem"
},
"title": "评论列表"
},
"product": {
"type": "string",
"title": "所属商品"
},
"product_spec": {
"type": "string",
"title": "产品规格"
}
}
},
"mallCommentListReply": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64",
"title": "数量"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallCommentItemRep"
},
"title": "评论列表"
}
}
},
"mallConfigsReply": {
"type": "object",
"properties": {
"configs": {
"type": "string"
}
}
},
"mallDenyRegionItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string"
},
"mall_identity": {
"type": "string"
},
"title": {
"type": "string",
"title": "名称"
},
"region": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallRegionItem"
},
"title": "限售区域"
}
}
},
"mallDenyRegionReply": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallDenyRegionItem"
}
}
}
},
"mallFreightAttrItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string"
},
"freight_identity": {
"type": "string",
"title": "模板唯一标识"
},
"region_str": {
"type": "string",
"title": "地区名称"
},
"region": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallRegionItem"
},
"title": "地区"
},
"price_basic": {
"type": "string",
"format": "int64",
"title": "起步运费"
},
"count_basic": {
"type": "string",
"format": "int64",
"title": "起步数量"
},
"count_extra": {
"type": "string",
"format": "int64",
"title": "加价数量"
},
"price_extra": {
"type": "string",
"format": "int64",
"title": "加价单价"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态1正常-1禁用"
},
"is_default": {
"type": "integer",
"format": "int32",
"title": "是否是默认1-不是2是"
}
}
},
"mallFreightItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "属性ID"
},
"identity": {
"type": "string",
"title": "唯一标识"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态1正常-1禁用"
},
"title": {
"type": "string",
"title": "名称"
},
"post_type": {
"type": "integer",
"format": "int32",
"title": "是否包邮1包邮2不包邮"
},
"quota": {
"type": "string",
"format": "int64",
"title": "当types=1时满额包邮"
},
"cost_type": {
"type": "integer",
"format": "int32",
"title": "计费类型1计件收费2按重收费,3按体积收费"
},
"region_type": {
"type": "integer",
"format": "int32",
"title": "区域限售:1限制2不限制"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallFreightAttrItem"
},
"title": "计费规则"
}
}
},
"mallFreightReply": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallFreightItem"
}
}
}
},
"mallListItem": {
"type": "object",
"properties": {
"product_id": {
"type": "string",
"format": "int64",
"title": "产品id"
},
"product": {
"type": "string",
"title": "产品名称"
},
"spec_id": {
"type": "string",
"format": "int64",
"title": "规格id"
},
"spec": {
"type": "string",
"title": "规格名称"
},
"spec_no": {
"type": "string",
"title": "规格编号"
},
"price": {
"type": "string",
"format": "int64",
"title": "单价,单位分"
},
"count": {
"type": "string",
"format": "int64",
"title": "数量"
},
"img": {
"type": "string",
"title": "产品图片"
},
"product_identity": {
"type": "string",
"title": "产品唯一标识"
},
"serial_id": {
"type": "string",
"title": "产品序号"
}
}
},
"mallListReply": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64",
"title": "数量"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallProductItem"
},
"title": "产品列表"
}
}
},
"mallLoginReply": {
"type": "object",
"properties": {
"token": {
"type": "string",
"title": "token 授权码"
},
"identity": {
"type": "string",
"title": "唯一标识"
},
"store_identity": {
"type": "string",
"title": "店铺唯一标识"
},
"name": {
"type": "string",
"title": "姓名"
},
"account": {
"type": "string",
"title": "账号"
},
"role": {
"type": "string",
"title": "角色"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"store_name": {
"type": "string",
"title": "店铺名称"
}
}
},
"mallMallSearchReply": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallStoreBasic"
}
},
"count": {
"type": "string",
"format": "int64"
}
}
},
"mallMiniCodeReply": {
"type": "object",
"properties": {
"img": {
"type": "string",
"title": "返回的数据将会根据参数types的变动而变动"
}
}
},
"mallNoticeItem": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "唯一标识"
},
"title": {
"type": "string",
"title": "标题"
},
"content": {
"type": "string",
"title": "内容"
},
"author": {
"type": "string",
"title": "作者"
},
"store_id": {
"type": "string",
"format": "int64",
"title": "店铺ID"
},
"store_identity": {
"type": "string",
"title": "店铺唯一标识"
},
"created_at": {
"type": "string"
},
"status": {
"type": "string",
"format": "int64",
"title": "状态默认为0-1禁止1为正常"
}
},
"title": "公告"
},
"mallNoticeListReply": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallNoticeItem"
}
},
"count": {
"type": "string",
"format": "int64"
}
},
"title": "公告列表"
},
"mallPhotoItem": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "图片名称"
},
"identity": {
"type": "string",
"title": "图片唯一标识"
},
"product_identity": {
"type": "string",
"title": "所属产品唯一标识"
},
"url": {
"type": "string",
"title": "图片地址"
},
"sort": {
"type": "integer",
"format": "int32",
"title": "排序方式"
},
"types": {
"type": "string",
"title": "cover封面img普通图片"
},
"id": {
"type": "string",
"format": "int64",
"title": "图片id"
}
}
},
"mallPhotoReply": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallPhotoItem"
}
}
},
"title": "---- Reply 部分"
},
"mallProductItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "商品ID"
},
"identity": {
"type": "string",
"title": "商品唯一码"
},
"supply_id": {
"type": "string",
"format": "int64",
"title": "供应商ID"
},
"category_id": {
"type": "array",
"items": {
"type": "string",
"format": "int64"
},
"title": "分类ID"
},
"title": {
"type": "string",
"title": "商品标题"
},
"measuring_name": {
"type": "string",
"title": "测量单位名称"
},
"sell_max": {
"type": "string",
"format": "int64",
"title": "最大限购数量"
},
"sell_min": {
"type": "string",
"format": "int64",
"title": "最小限购数量"
},
"wastage": {
"type": "string",
"format": "int64",
"title": "损耗率"
},
"standard_number": {
"type": "string",
"title": "产品标准号"
},
"brand": {
"type": "string",
"title": "品牌名称"
},
"stock_type": {
"type": "string",
"format": "int64",
"title": "库存计数方式1-买方下单减库存2-完成签约减库存"
},
"status": {
"type": "integer",
"format": "int32",
"title": "商品状态1-已上架2-自动上架等待中3-禁用 4-草稿,5-未上架"
},
"putaway_time": {
"type": "string",
"title": "预定的上架时间 YYYY-MM-DD HH:mm:ss"
},
"cover_image": {
"type": "string",
"title": "商品封面图片"
},
"content": {
"type": "string",
"title": "商品详情"
},
"store_id": {
"type": "string",
"format": "int64",
"title": "店铺的ID"
},
"store_identity": {
"type": "string",
"title": "店铺唯一标识"
},
"template_id": {
"type": "integer",
"format": "int32",
"title": "运费模板id"
},
"note": {
"type": "string",
"title": "备注"
},
"images": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallPhotoItem"
},
"title": "产品图片"
},
"specification": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallSpecItem"
},
"title": "产品规格信息"
},
"recent_number": {
"type": "string",
"format": "int64",
"title": "近期销售数量"
},
"sale_total": {
"type": "string",
"format": "int64",
"title": "销售总数量"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"limitation": {
"type": "string",
"format": "int64",
"title": "区域限制1不限制2限制"
},
"liTemplate_id": {
"type": "string",
"format": "int64",
"title": "区域限制的模板id"
},
"price": {
"type": "string",
"format": "int64",
"title": "售价(选择价格最低的规格数据)"
},
"stock": {
"type": "string",
"format": "int64",
"title": "库存(选择价格最低的规格数据)"
},
"category": {
"type": "string",
"title": "分类名称"
},
"serial_id": {
"type": "string",
"title": "产品序号"
},
"gas_types": {
"type": "string",
"format": "int64",
"title": "产品分类21查看非燃气商品2按瓶计算的产品3按kg计算的产品"
},
"spec_id": {
"type": "array",
"items": {
"type": "string",
"format": "int64"
},
"title": "规格ID"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallCategoriesItem"
},
"title": "分类"
},
"supply_name": {
"type": "string",
"title": "供应商名称"
}
}
},
"mallRegionItem": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"second": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallRegionItem"
}
}
}
},
"mallSpecItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "唯一标识"
},
"supply_id": {
"type": "string",
"format": "int64",
"title": "供应商ID"
},
"product_identity": {
"type": "string",
"title": "产品唯一标识"
},
"store_identity": {
"type": "string",
"title": "店铺唯一标识"
},
"title": {
"type": "string",
"title": "名称"
},
"stock_type": {
"type": "integer",
"format": "int32",
"title": "库存设置1-设置库存限制2-不设置库存限制"
},
"stock": {
"type": "string",
"format": "int64",
"title": "库存数量"
},
"price": {
"type": "string",
"format": "int64",
"title": "价格,单位:分"
},
"direct_sales": {
"type": "string",
"format": "int64",
"title": "直营价格,单位:分"
},
"tp_type": {
"type": "integer",
"format": "int32",
"title": "阶梯价设置:1-启用,2-不启用"
},
"ds_tp_type": {
"type": "integer",
"format": "int32",
"title": "直营阶梯价设置:1-启用,2-不启用"
},
"img": {
"type": "string",
"title": "预览图"
},
"spec_no": {
"type": "string",
"title": "规格编号"
},
"keyword": {
"type": "string",
"title": "关键字"
},
"purchasing_price": {
"type": "string",
"format": "int64",
"title": "进口价格,单位:分"
},
"wholesale": {
"type": "string",
"format": "int64",
"title": "代理价,单位:分"
}
}
},
"mallSpecReply": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallSpecItem"
}
}
}
},
"mallStaffItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "id"
},
"identity": {
"type": "string",
"title": "唯一标识"
},
"name": {
"type": "string",
"title": "姓名"
},
"account": {
"type": "string",
"title": "账号"
},
"password": {
"type": "string",
"title": "密码"
},
"profile": {
"type": "string",
"title": "简介"
},
"role": {
"type": "string",
"title": "角色"
},
"phone": {
"type": "string",
"title": "手机号"
},
"email": {
"type": "string",
"title": "邮箱"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态默认为0-1禁止1为正常"
},
"avatar": {
"type": "string",
"title": "头像"
},
"created_at": {
"type": "string"
}
}
},
"mallStaffListReply": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/mallStaffItem"
}
},
"count": {
"type": "string",
"format": "int64"
}
}
},
"mallStatusReply": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"title": "状态码"
},
"identity": {
"type": "string",
"title": "标识码"
},
"message": {
"type": "string",
"title": "状态说明"
},
"timeseq": {
"type": "string",
"format": "int64",
"title": "响应时间序列"
}
}
},
"mallStoreBasic": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "店铺唯一标识"
},
"logo": {
"type": "string",
"title": "logo"
},
"title": {
"type": "string",
"title": "标题"
},
"intro": {
"type": "string",
"title": "描述说明"
},
"template": {
"type": "string",
"title": "模板"
},
"configs": {
"type": "string",
"title": "配置说明"
},
"subdomain": {
"type": "string",
"title": "子域名设置,可选"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态"
},
"keywords": {
"type": "string",
"title": "SEO 关键词"
},
"approve": {
"type": "integer",
"format": "int32",
"title": "审核状态:0待审核,1审核通过,2审核失败"
}
}
},
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
},
"rpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/protobufAny"
}
}
}
}
}
}