46 KiB
46 KiB
MALL API
商城广告、类目、运费、公告、商品、员工和店铺管理。
本文档由 protobuf descriptor 生成。字段名采用 protobuf JSON 名称;64 位整数在 JSON 中应按字符串处理。
接入方式
- 动态 HTTP:
POST /rpc/mall/{Service}/{Method} - 原生 gRPC:
/mall.{Service}/{Method} - grpc-gateway:
POST /mall.{Service}/{Method} - 鉴权:需要登录的接口通过
Authorization: Bearer <token>传递凭证。 - 动态 HTTP 成功或失败均返回 HTTP 200,业务状态见
code、message、details。
服务概览
| 服务 | 方法数 | 说明 |
|---|---|---|
Ads |
5 | Ads 服务 |
Category |
4 | Category 服务 |
Freight |
9 | Freight 服务 |
Notice |
4 | Notice 服务 |
Product |
21 | Product 服务 |
Staff |
7 | Staff 服务 |
Store |
10 | Store 服务 |
Ads
| 方法 | 动态 HTTP 路径 | 请求 | 响应 | 类型 |
|---|---|---|---|---|
ByPos |
POST /rpc/mall/Ads/ByPos |
mall.ByPosRequest |
mall.AdsListReply |
Unary |
Fetch |
POST /rpc/mall/Ads/Fetch |
ec_mall_blocks.MallFetchRequest |
mall.AdsListReply |
Unary |
Create |
POST /rpc/mall/Ads/Create |
mall.AdsItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Modify |
POST /rpc/mall/Ads/Modify |
mall.AdsItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Delete |
POST /rpc/mall/Ads/Delete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
Ads.ByPos
- 动态 HTTP:
POST /rpc/mall/Ads/ByPos - gRPC:
/mall.Ads/ByPos - 白名单键:
mall.Ads.ByPos - 请求示例:
{
"pos_key": [
"string"
],
"store_identity": "string"
}
Ads.Fetch
- 动态 HTTP:
POST /rpc/mall/Ads/Fetch - gRPC:
/mall.Ads/Fetch - 白名单键:
mall.Ads.Fetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Ads.Create
- 动态 HTTP:
POST /rpc/mall/Ads/Create - gRPC:
/mall.Ads/Create - 白名单键:
mall.Ads.Create - 请求示例:
{
"content": "string",
"created_at": "string",
"id": "0",
"pos_key": "string",
"status": "0",
"title": "string",
"to_url": "string",
"type": 0
}
Ads.Modify
- 动态 HTTP:
POST /rpc/mall/Ads/Modify - gRPC:
/mall.Ads/Modify - 白名单键:
mall.Ads.Modify - 请求示例:
{
"content": "string",
"created_at": "string",
"id": "0",
"pos_key": "string",
"status": "0",
"title": "string",
"to_url": "string",
"type": 0
}
Ads.Delete
- 动态 HTTP:
POST /rpc/mall/Ads/Delete - gRPC:
/mall.Ads/Delete - 白名单键:
mall.Ads.Delete - 请求示例:
{
"id": "0",
"identity": "string"
}
Category
| 方法 | 动态 HTTP 路径 | 请求 | 响应 | 类型 |
|---|---|---|---|---|
Fetch |
POST /rpc/mall/Category/Fetch |
mall.CategoryFetchRequest |
mall.CategoryReply |
Unary |
Create |
POST /rpc/mall/Category/Create |
mall.CategoryItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Delete |
POST /rpc/mall/Category/Delete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
Modify |
POST /rpc/mall/Category/Modify |
mall.CategoryItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Category.Fetch
- 动态 HTTP:
POST /rpc/mall/Category/Fetch - gRPC:
/mall.Category/Fetch - 白名单键:
mall.Category.Fetch - 请求示例:
{
"id": "0",
"keywords": "string",
"store_identity": "string",
"types": "string"
}
Category.Create
- 动态 HTTP:
POST /rpc/mall/Category/Create - gRPC:
/mall.Category/Create - 白名单键:
mall.Category.Create - 请求示例:
{
"categories": [
{}
],
"created_at": "string",
"en_title": "string",
"icon": "string",
"id": "0",
"identity": "string",
"intro": "string",
"keys": "string",
"parent_id": "0",
"paths": "string",
"sort": 0,
"status": 0,
"title": "string"
}
Category.Delete
- 动态 HTTP:
POST /rpc/mall/Category/Delete - gRPC:
/mall.Category/Delete - 白名单键:
mall.Category.Delete - 请求示例:
{
"id": "0",
"identity": "string"
}
Category.Modify
- 动态 HTTP:
POST /rpc/mall/Category/Modify - gRPC:
/mall.Category/Modify - 白名单键:
mall.Category.Modify - 请求示例:
{
"categories": [
{}
],
"created_at": "string",
"en_title": "string",
"icon": "string",
"id": "0",
"identity": "string",
"intro": "string",
"keys": "string",
"parent_id": "0",
"paths": "string",
"sort": 0,
"status": 0,
"title": "string"
}
Freight
| 方法 | 动态 HTTP 路径 | 请求 | 响应 | 类型 |
|---|---|---|---|---|
Fetch |
POST /rpc/mall/Freight/Fetch |
ec_mall_blocks.MallFetchRequest |
mall.FreightReply |
Unary |
Modify |
POST /rpc/mall/Freight/Modify |
mall.FreightItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Delete |
POST /rpc/mall/Freight/Delete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
Create |
POST /rpc/mall/Freight/Create |
mall.FreightItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Detail |
POST /rpc/mall/Freight/Detail |
ec_mall_blocks.IdentRequest |
mall.FreightItem |
Unary |
DenyRegionFetch |
POST /rpc/mall/Freight/DenyRegionFetch |
ec_mall_blocks.MallFetchRequest |
mall.DenyRegionReply |
Unary |
DenyRegionCreate |
POST /rpc/mall/Freight/DenyRegionCreate |
mall.DenyRegionItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
DenyRegionDelete |
POST /rpc/mall/Freight/DenyRegionDelete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
DenyRegionModify |
POST /rpc/mall/Freight/DenyRegionModify |
mall.DenyRegionItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Freight.Fetch
- 动态 HTTP:
POST /rpc/mall/Freight/Fetch - gRPC:
/mall.Freight/Fetch - 白名单键:
mall.Freight.Fetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Freight.Modify
- 动态 HTTP:
POST /rpc/mall/Freight/Modify - gRPC:
/mall.Freight/Modify - 白名单键:
mall.Freight.Modify - 请求示例:
{
"cost_type": 0,
"id": "0",
"identity": "string",
"post_type": 0,
"quota": "0",
"region_type": 0,
"rules": [
{
"count_basic": "0",
"count_extra": "0",
"freight_identity": "string",
"id": "0",
"identity": "string",
"is_default": 0,
"price_basic": "0",
"price_extra": "0",
"region": [
{
"id": 0,
"name": "string",
"second": [
{}
]
}
],
"region_str": "string",
"status": 0
}
],
"status": 0,
"title": "string"
}
Freight.Delete
- 动态 HTTP:
POST /rpc/mall/Freight/Delete - gRPC:
/mall.Freight/Delete - 白名单键:
mall.Freight.Delete - 请求示例:
{
"id": "0",
"identity": "string"
}
Freight.Create
- 动态 HTTP:
POST /rpc/mall/Freight/Create - gRPC:
/mall.Freight/Create - 白名单键:
mall.Freight.Create - 请求示例:
{
"cost_type": 0,
"id": "0",
"identity": "string",
"post_type": 0,
"quota": "0",
"region_type": 0,
"rules": [
{
"count_basic": "0",
"count_extra": "0",
"freight_identity": "string",
"id": "0",
"identity": "string",
"is_default": 0,
"price_basic": "0",
"price_extra": "0",
"region": [
{
"id": 0,
"name": "string",
"second": [
{}
]
}
],
"region_str": "string",
"status": 0
}
],
"status": 0,
"title": "string"
}
Freight.Detail
- 动态 HTTP:
POST /rpc/mall/Freight/Detail - gRPC:
/mall.Freight/Detail - 白名单键:
mall.Freight.Detail - 请求示例:
{
"id": "0",
"identity": "string"
}
Freight.DenyRegionFetch
- 动态 HTTP:
POST /rpc/mall/Freight/DenyRegionFetch - gRPC:
/mall.Freight/DenyRegionFetch - 白名单键:
mall.Freight.DenyRegionFetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Freight.DenyRegionCreate
- 动态 HTTP:
POST /rpc/mall/Freight/DenyRegionCreate - gRPC:
/mall.Freight/DenyRegionCreate - 白名单键:
mall.Freight.DenyRegionCreate - 请求示例:
{
"id": "0",
"identity": "string",
"mall_identity": "string",
"region": [
{
"id": 0,
"name": "string",
"second": [
{}
]
}
],
"title": "string"
}
Freight.DenyRegionDelete
- 动态 HTTP:
POST /rpc/mall/Freight/DenyRegionDelete - gRPC:
/mall.Freight/DenyRegionDelete - 白名单键:
mall.Freight.DenyRegionDelete - 请求示例:
{
"id": "0",
"identity": "string"
}
Freight.DenyRegionModify
- 动态 HTTP:
POST /rpc/mall/Freight/DenyRegionModify - gRPC:
/mall.Freight/DenyRegionModify - 白名单键:
mall.Freight.DenyRegionModify - 请求示例:
{
"id": "0",
"identity": "string",
"mall_identity": "string",
"region": [
{
"id": 0,
"name": "string",
"second": [
{}
]
}
],
"title": "string"
}
Notice
| 方法 | 动态 HTTP 路径 | 请求 | 响应 | 类型 |
|---|---|---|---|---|
Fetch |
POST /rpc/mall/Notice/Fetch |
ec_mall_blocks.MallFetchRequest |
mall.NoticeListReply |
Unary |
Create |
POST /rpc/mall/Notice/Create |
mall.NoticeItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Modify |
POST /rpc/mall/Notice/Modify |
mall.NoticeItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Delete |
POST /rpc/mall/Notice/Delete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
Notice.Fetch
- 动态 HTTP:
POST /rpc/mall/Notice/Fetch - gRPC:
/mall.Notice/Fetch - 白名单键:
mall.Notice.Fetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Notice.Create
- 动态 HTTP:
POST /rpc/mall/Notice/Create - gRPC:
/mall.Notice/Create - 白名单键:
mall.Notice.Create - 请求示例:
{
"author": "string",
"content": "string",
"created_at": "string",
"identity": "string",
"status": "0",
"store_id": "0",
"store_identity": "string",
"title": "string"
}
Notice.Modify
- 动态 HTTP:
POST /rpc/mall/Notice/Modify - gRPC:
/mall.Notice/Modify - 白名单键:
mall.Notice.Modify - 请求示例:
{
"author": "string",
"content": "string",
"created_at": "string",
"identity": "string",
"status": "0",
"store_id": "0",
"store_identity": "string",
"title": "string"
}
Notice.Delete
- 动态 HTTP:
POST /rpc/mall/Notice/Delete - gRPC:
/mall.Notice/Delete - 白名单键:
mall.Notice.Delete - 请求示例:
{
"id": "0",
"identity": "string"
}
Product
| 方法 | 动态 HTTP 路径 | 请求 | 响应 | 类型 |
|---|---|---|---|---|
ItemFetch |
POST /rpc/mall/Product/ItemFetch |
ec_mall_blocks.MallFetchRequest |
mall.ListReply |
Unary |
ItemDetail |
POST /rpc/mall/Product/ItemDetail |
ec_mall_blocks.IdentRequest |
mall.ProductItem |
Unary |
ItemDetailBySerial |
POST /rpc/mall/Product/ItemDetailBySerial |
ec_mall_blocks.StoreSerialRequest |
mall.ListReply |
Unary |
ItemDetailBySpec |
POST /rpc/mall/Product/ItemDetailBySpec |
mall.DetailBySpecRequest |
mall.ListItem |
Unary |
ItemCreate |
POST /rpc/mall/Product/ItemCreate |
mall.ProductItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
ItemDelete |
POST /rpc/mall/Product/ItemDelete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
ItemModify |
POST /rpc/mall/Product/ItemModify |
mall.ModifyRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
ItemBatchOp |
POST /rpc/mall/Product/ItemBatchOp |
mall.OpRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
SpecFetch |
POST /rpc/mall/Product/SpecFetch |
ec_mall_blocks.MallFetchRequest |
mall.SpecReply |
Unary |
SpecCreate |
POST /rpc/mall/Product/SpecCreate |
mall.SpecItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
SpecModify |
POST /rpc/mall/Product/SpecModify |
mall.SpecItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
SpecDelete |
POST /rpc/mall/Product/SpecDelete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
SpecDetail |
POST /rpc/mall/Product/SpecDetail |
ec_mall_blocks.IdentRequest |
mall.SpecItem |
Unary |
PhotoCreate |
POST /rpc/mall/Product/PhotoCreate |
mall.PhotoItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
PhotoDelete |
POST /rpc/mall/Product/PhotoDelete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
PhotoList |
POST /rpc/mall/Product/PhotoList |
mall.PhotoItem |
mall.PhotoReply |
Unary |
CommentFetch |
POST /rpc/mall/Product/CommentFetch |
ec_mall_blocks.MallFetchRequest |
mall.CommentListReply |
Unary |
CommentCreate |
POST /rpc/mall/Product/CommentCreate |
mall.CommentItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
CommentRe |
POST /rpc/mall/Product/CommentRe |
mall.CommentItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
CommentDelete |
POST /rpc/mall/Product/CommentDelete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
CommentModify |
POST /rpc/mall/Product/CommentModify |
mall.CommentItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Product.ItemFetch
- 动态 HTTP:
POST /rpc/mall/Product/ItemFetch - gRPC:
/mall.Product/ItemFetch - 白名单键:
mall.Product.ItemFetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Product.ItemDetail
- 动态 HTTP:
POST /rpc/mall/Product/ItemDetail - gRPC:
/mall.Product/ItemDetail - 白名单键:
mall.Product.ItemDetail - 请求示例:
{
"id": "0",
"identity": "string"
}
Product.ItemDetailBySerial
- 动态 HTTP:
POST /rpc/mall/Product/ItemDetailBySerial - gRPC:
/mall.Product/ItemDetailBySerial - 白名单键:
mall.Product.ItemDetailBySerial - 请求示例:
{
"serial_id": [
"string"
],
"store_identity": "string"
}
Product.ItemDetailBySpec
- 动态 HTTP:
POST /rpc/mall/Product/ItemDetailBySpec - gRPC:
/mall.Product/ItemDetailBySpec - 白名单键:
mall.Product.ItemDetailBySpec - 请求示例:
{
"spec_no": "string"
}
Product.ItemCreate
- 动态 HTTP:
POST /rpc/mall/Product/ItemCreate - gRPC:
/mall.Product/ItemCreate - 白名单键:
mall.Product.ItemCreate - 请求示例:
{
"brand": "string",
"categories": [
{
"categories": [
{}
],
"created_at": "string",
"en_title": "string",
"icon": "string",
"id": "0",
"identity": "string",
"intro": "string",
"keys": "string",
"parent_id": "0",
"paths": "string",
"sort": 0,
"status": 0,
"title": "string"
}
],
"category": "string",
"category_id": [
"0"
],
"content": "string",
"cover_image": "string",
"created_at": "string",
"gas_types": "0",
"id": "0",
"identity": "string",
"images": [
{
"id": "0",
"identity": "string",
"name": "string",
"product_identity": "string",
"sort": 0,
"types": "string",
"url": "string"
}
],
"liTemplate_id": "0",
"limitation": "0",
"measuring_name": "string",
"note": "string",
"price": "0",
"putaway_time": "string",
"recent_number": "0",
"sale_total": "0",
"sell_max": "0",
"sell_min": "0",
"serial_id": "string",
"spec_id": [
"0"
],
"specification": [
{
"direct_sales": "0",
"ds_tp_type": 0,
"id": "0",
"identity": "string",
"img": "string",
"keyword": "string",
"price": "0",
"product_identity": "string",
"purchasing_price": "0",
"spec_no": "string",
"stock": "0",
"stock_type": 0,
"store_identity": "string",
"supply_id": "0",
"title": "string",
"tp_type": 0,
"wholesale": "0"
}
],
"standard_number": "string",
"status": 0,
"stock": "0",
"stock_type": "0",
"store_id": "0",
"store_identity": "string",
"supply_id": "0",
"supply_name": "string",
"template_id": 0,
"title": "string",
"wastage": "0"
}
Product.ItemDelete
- 动态 HTTP:
POST /rpc/mall/Product/ItemDelete - gRPC:
/mall.Product/ItemDelete - 白名单键:
mall.Product.ItemDelete - 请求示例:
{
"id": "0",
"identity": "string"
}
Product.ItemModify
- 动态 HTTP:
POST /rpc/mall/Product/ItemModify - gRPC:
/mall.Product/ItemModify - 白名单键:
mall.Product.ItemModify - 请求示例:
{
"identity": "string",
"status": 0
}
Product.ItemBatchOp
- 动态 HTTP:
POST /rpc/mall/Product/ItemBatchOp - gRPC:
/mall.Product/ItemBatchOp - 白名单键:
mall.Product.ItemBatchOp - 请求示例:
{
"identity": [
"string"
],
"status": 0
}
Product.SpecFetch
- 动态 HTTP:
POST /rpc/mall/Product/SpecFetch - gRPC:
/mall.Product/SpecFetch - 白名单键:
mall.Product.SpecFetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Product.SpecCreate
- 动态 HTTP:
POST /rpc/mall/Product/SpecCreate - gRPC:
/mall.Product/SpecCreate - 白名单键:
mall.Product.SpecCreate - 请求示例:
{
"direct_sales": "0",
"ds_tp_type": 0,
"id": "0",
"identity": "string",
"img": "string",
"keyword": "string",
"price": "0",
"product_identity": "string",
"purchasing_price": "0",
"spec_no": "string",
"stock": "0",
"stock_type": 0,
"store_identity": "string",
"supply_id": "0",
"title": "string",
"tp_type": 0,
"wholesale": "0"
}
Product.SpecModify
- 动态 HTTP:
POST /rpc/mall/Product/SpecModify - gRPC:
/mall.Product/SpecModify - 白名单键:
mall.Product.SpecModify - 请求示例:
{
"direct_sales": "0",
"ds_tp_type": 0,
"id": "0",
"identity": "string",
"img": "string",
"keyword": "string",
"price": "0",
"product_identity": "string",
"purchasing_price": "0",
"spec_no": "string",
"stock": "0",
"stock_type": 0,
"store_identity": "string",
"supply_id": "0",
"title": "string",
"tp_type": 0,
"wholesale": "0"
}
Product.SpecDelete
- 动态 HTTP:
POST /rpc/mall/Product/SpecDelete - gRPC:
/mall.Product/SpecDelete - 白名单键:
mall.Product.SpecDelete - 请求示例:
{
"id": "0",
"identity": "string"
}
Product.SpecDetail
- 动态 HTTP:
POST /rpc/mall/Product/SpecDetail - gRPC:
/mall.Product/SpecDetail - 白名单键:
mall.Product.SpecDetail - 请求示例:
{
"id": "0",
"identity": "string"
}
Product.PhotoCreate
- 动态 HTTP:
POST /rpc/mall/Product/PhotoCreate - gRPC:
/mall.Product/PhotoCreate - 白名单键:
mall.Product.PhotoCreate - 请求示例:
{
"id": "0",
"identity": "string",
"name": "string",
"product_identity": "string",
"sort": 0,
"types": "string",
"url": "string"
}
Product.PhotoDelete
- 动态 HTTP:
POST /rpc/mall/Product/PhotoDelete - gRPC:
/mall.Product/PhotoDelete - 白名单键:
mall.Product.PhotoDelete - 请求示例:
{
"id": "0",
"identity": "string"
}
Product.PhotoList
- 动态 HTTP:
POST /rpc/mall/Product/PhotoList - gRPC:
/mall.Product/PhotoList - 白名单键:
mall.Product.PhotoList - 请求示例:
{
"id": "0",
"identity": "string",
"name": "string",
"product_identity": "string",
"sort": 0,
"types": "string",
"url": "string"
}
Product.CommentFetch
- 动态 HTTP:
POST /rpc/mall/Product/CommentFetch - gRPC:
/mall.Product/CommentFetch - 白名单键:
mall.Product.CommentFetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Product.CommentCreate
- 动态 HTTP:
POST /rpc/mall/Product/CommentCreate - gRPC:
/mall.Product/CommentCreate - 白名单键:
mall.Product.CommentCreate - 请求示例:
{
"comment": "string",
"comment_identity": "string",
"created_at": "string",
"id": "0",
"identity": "string",
"is_comment": false,
"nick_name": "string",
"product": "string",
"product_identity": "string",
"product_spec": "string",
"reply": "string",
"score": 0,
"spec_identity": "string",
"store_identity": "string"
}
Product.CommentRe
- 动态 HTTP:
POST /rpc/mall/Product/CommentRe - gRPC:
/mall.Product/CommentRe - 白名单键:
mall.Product.CommentRe - 请求示例:
{
"comment": "string",
"comment_identity": "string",
"created_at": "string",
"id": "0",
"identity": "string",
"is_comment": false,
"nick_name": "string",
"product": "string",
"product_identity": "string",
"product_spec": "string",
"reply": "string",
"score": 0,
"spec_identity": "string",
"store_identity": "string"
}
Product.CommentDelete
- 动态 HTTP:
POST /rpc/mall/Product/CommentDelete - gRPC:
/mall.Product/CommentDelete - 白名单键:
mall.Product.CommentDelete - 请求示例:
{
"id": "0",
"identity": "string"
}
Product.CommentModify
- 动态 HTTP:
POST /rpc/mall/Product/CommentModify - gRPC:
/mall.Product/CommentModify - 白名单键:
mall.Product.CommentModify - 请求示例:
{
"comment": "string",
"comment_identity": "string",
"created_at": "string",
"id": "0",
"identity": "string",
"is_comment": false,
"nick_name": "string",
"product": "string",
"product_identity": "string",
"product_spec": "string",
"reply": "string",
"score": 0,
"spec_identity": "string",
"store_identity": "string"
}
Staff
| 方法 | 动态 HTTP 路径 | 请求 | 响应 | 类型 |
|---|---|---|---|---|
Login |
POST /rpc/mall/Staff/Login |
mall.LoginRequest |
mall.LoginReply |
Unary |
Fetch |
POST /rpc/mall/Staff/Fetch |
ec_mall_blocks.MallFetchRequest |
mall.StaffListReply |
Unary |
Create |
POST /rpc/mall/Staff/Create |
mall.StaffItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
Delete |
POST /rpc/mall/Staff/Delete |
ec_mall_blocks.IdentRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
GetProfile |
POST /rpc/mall/Staff/GetProfile |
ec_mall_blocks.IdentRequest |
mall.StaffItem |
Unary |
SetProfile |
POST /rpc/mall/Staff/SetProfile |
mall.StaffItem |
ec_mall_blocks.IdentityStatusReply |
Unary |
SetPassword |
POST /rpc/mall/Staff/SetPassword |
mall.SetAccountRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
Staff.Login
- 动态 HTTP:
POST /rpc/mall/Staff/Login - gRPC:
/mall.Staff/Login - 白名单键:
mall.Staff.Login - 请求示例:
{
"account": "string",
"login_genre": 0,
"password": "string",
"phone": "string",
"verify_code": "string"
}
Staff.Fetch
- 动态 HTTP:
POST /rpc/mall/Staff/Fetch - gRPC:
/mall.Staff/Fetch - 白名单键:
mall.Staff.Fetch - 请求示例:
{
"categoryId": [
"0"
],
"keyword": "string",
"max_price": "0",
"min_price": "0",
"page_no": "0",
"page_size": "0",
"params": {
"key": "string"
},
"sort": "string",
"store_identity": "string"
}
Staff.Create
- 动态 HTTP:
POST /rpc/mall/Staff/Create - gRPC:
/mall.Staff/Create - 白名单键:
mall.Staff.Create - 请求示例:
{
"account": "string",
"avatar": "string",
"created_at": "string",
"email": "string",
"id": "0",
"identity": "string",
"name": "string",
"password": "string",
"phone": "string",
"profile": "string",
"role": "string",
"status": 0
}
Staff.Delete
- 动态 HTTP:
POST /rpc/mall/Staff/Delete - gRPC:
/mall.Staff/Delete - 白名单键:
mall.Staff.Delete - 请求示例:
{
"id": "0",
"identity": "string"
}
Staff.GetProfile
- 动态 HTTP:
POST /rpc/mall/Staff/GetProfile - gRPC:
/mall.Staff/GetProfile - 白名单键:
mall.Staff.GetProfile - 请求示例:
{
"id": "0",
"identity": "string"
}
Staff.SetProfile
- 动态 HTTP:
POST /rpc/mall/Staff/SetProfile - gRPC:
/mall.Staff/SetProfile - 白名单键:
mall.Staff.SetProfile - 请求示例:
{
"account": "string",
"avatar": "string",
"created_at": "string",
"email": "string",
"id": "0",
"identity": "string",
"name": "string",
"password": "string",
"phone": "string",
"profile": "string",
"role": "string",
"status": 0
}
Staff.SetPassword
- 动态 HTTP:
POST /rpc/mall/Staff/SetPassword - gRPC:
/mall.Staff/SetPassword - 白名单键:
mall.Staff.SetPassword - 请求示例:
{
"account": "string",
"password": "string",
"password_confirmed": "string"
}
Store
| 方法 | 动态 HTTP 路径 | 请求 | 响应 | 类型 |
|---|---|---|---|---|
ApplyJoin |
POST /rpc/mall/Store/ApplyJoin |
mall.ApplyJoinRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
Licensing |
POST /rpc/mall/Store/Licensing |
mall.LicensingRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
GetSetting |
POST /rpc/mall/Store/GetSetting |
ec_mall_blocks.IdentRequest |
mall.StoreBasic |
Unary |
SetSetting |
POST /rpc/mall/Store/SetSetting |
mall.StoreBasic |
ec_mall_blocks.IdentityStatusReply |
Unary |
SetPayment |
POST /rpc/mall/Store/SetPayment |
mall.SettingRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
SetEmail |
POST /rpc/mall/Store/SetEmail |
mall.SettingRequest |
ec_mall_blocks.IdentityStatusReply |
Unary |
GetPayment |
POST /rpc/mall/Store/GetPayment |
ec_mall_blocks.IdentRequest |
mall.ConfigsReply |
Unary |
GetEmail |
POST /rpc/mall/Store/GetEmail |
ec_mall_blocks.IdentRequest |
mall.ConfigsReply |
Unary |
MiniCode |
POST /rpc/mall/Store/MiniCode |
mall.MiniCodeRequest |
mall.MiniCodeReply |
Unary |
Search |
POST /rpc/mall/Store/Search |
mall.MallSearchRequest |
mall.MallSearchReply |
Unary |
Store.ApplyJoin
- 动态 HTTP:
POST /rpc/mall/Store/ApplyJoin - gRPC:
/mall.Store/ApplyJoin - 白名单键:
mall.Store.ApplyJoin - 请求示例:
{
"account": "string",
"apply_remarks": "string",
"configs": "string",
"email": "string",
"intro": "string",
"logo": "string",
"name": "string",
"password": "string",
"phone": "string",
"subdomain": "string",
"template": "string",
"title": "string"
}
Store.Licensing
- 动态 HTTP:
POST /rpc/mall/Store/Licensing - gRPC:
/mall.Store/Licensing - 白名单键:
mall.Store.Licensing - 请求示例:
{
"domain": "string",
"host": "string",
"ip": "string",
"license": "string",
"license_type": "string"
}
Store.GetSetting
- 动态 HTTP:
POST /rpc/mall/Store/GetSetting - gRPC:
/mall.Store/GetSetting - 白名单键:
mall.Store.GetSetting - 请求示例:
{
"id": "0",
"identity": "string"
}
Store.SetSetting
- 动态 HTTP:
POST /rpc/mall/Store/SetSetting - gRPC:
/mall.Store/SetSetting - 白名单键:
mall.Store.SetSetting - 请求示例:
{
"approve": 0,
"configs": "string",
"created_at": "string",
"id": "0",
"identity": "string",
"intro": "string",
"keywords": "string",
"logo": "string",
"status": 0,
"subdomain": "string",
"template": "string",
"title": "string"
}
Store.SetPayment
- 动态 HTTP:
POST /rpc/mall/Store/SetPayment - gRPC:
/mall.Store/SetPayment - 白名单键:
mall.Store.SetPayment - 请求示例:
{
"configs": "string",
"identity": "string"
}
Store.SetEmail
- 动态 HTTP:
POST /rpc/mall/Store/SetEmail - gRPC:
/mall.Store/SetEmail - 白名单键:
mall.Store.SetEmail - 请求示例:
{
"configs": "string",
"identity": "string"
}
Store.GetPayment
- 动态 HTTP:
POST /rpc/mall/Store/GetPayment - gRPC:
/mall.Store/GetPayment - 白名单键:
mall.Store.GetPayment - 请求示例:
{
"id": "0",
"identity": "string"
}
Store.GetEmail
- 动态 HTTP:
POST /rpc/mall/Store/GetEmail - gRPC:
/mall.Store/GetEmail - 白名单键:
mall.Store.GetEmail - 请求示例:
{
"id": "0",
"identity": "string"
}
Store.MiniCode
- 动态 HTTP:
POST /rpc/mall/Store/MiniCode - gRPC:
/mall.Store/MiniCode - 白名单键:
mall.Store.MiniCode - 请求示例:
{
"types": "string"
}
Store.Search
- 动态 HTTP:
POST /rpc/mall/Store/Search - gRPC:
/mall.Store/Search - 白名单键:
mall.Store.Search - 请求示例:
{
"keyword": "string",
"page_no": "0",
"page_size": "0"
}
消息结构
ec_mall_blocks.IdentRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
ec_mall_blocks.IdentityStatusReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
code |
int32 |
可选 |
identity |
string |
可选 |
message |
string |
可选 |
timeseq |
int64 |
可选 |
ec_mall_blocks.MallFetchRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
page_no |
int64 |
可选 |
page_size |
int64 |
可选 |
params |
map<string, string> |
对象映射 |
store_identity |
string |
可选 |
keyword |
string |
可选 |
categoryId |
[]int64 |
数组 |
sort |
string |
可选 |
min_price |
int64 |
可选 |
max_price |
int64 |
可选 |
ec_mall_blocks.MallFetchRequest.ParamsEntry
| JSON 字段 | 类型 | 规则 |
|---|---|---|
key |
string |
可选 |
value |
string |
可选 |
ec_mall_blocks.StoreSerialRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
store_identity |
string |
可选 |
serial_id |
[]string |
数组 |
mall.AdsItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
pos_key |
string |
可选 |
title |
string |
可选 |
content |
string |
可选 |
type |
int32 |
可选 |
to_url |
string |
可选 |
created_at |
string |
可选 |
status |
int64 |
可选 |
mall.AdsListReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
data |
[]mall.AdsItem |
数组 |
count |
int64 |
可选 |
mall.ApplyJoinRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
logo |
string |
可选 |
title |
string |
可选 |
intro |
string |
可选 |
template |
string |
可选 |
configs |
string |
可选 |
subdomain |
string |
可选 |
apply_remarks |
string |
可选 |
name |
string |
可选 |
account |
string |
可选 |
phone |
string |
可选 |
email |
string |
可选 |
password |
string |
可选 |
mall.ByPosRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
pos_key |
[]string |
数组 |
store_identity |
string |
可选 |
mall.CategoriesItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
title |
string |
可选 |
en_title |
string |
可选 |
parent_id |
int64 |
可选 |
paths |
string |
可选 |
intro |
string |
可选 |
icon |
string |
可选 |
sort |
int32 |
可选 |
status |
int32 |
可选 |
created_at |
string |
可选 |
categories |
[]mall.CategoriesItem |
数组 |
keys |
string |
可选 |
mall.CategoryFetchRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
types |
string |
可选 |
keywords |
string |
可选 |
id |
int64 |
可选 |
store_identity |
string |
可选 |
mall.CategoryItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
title |
string |
可选 |
en_title |
string |
可选 |
parent_id |
int64 |
可选 |
paths |
string |
可选 |
intro |
string |
可选 |
icon |
string |
可选 |
sort |
int32 |
可选 |
status |
int32 |
可选 |
created_at |
string |
可选 |
categories |
[]mall.CategoryItem |
数组 |
keys |
string |
可选 |
mall.CategoryReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
count |
int64 |
可选 |
data |
[]mall.CategoryItem |
数组 |
mall.CommentItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
created_at |
string |
可选 |
nick_name |
string |
可选 |
score |
int32 |
可选 |
comment |
string |
可选 |
reply |
string |
可选 |
product_identity |
string |
可选 |
store_identity |
string |
可选 |
spec_identity |
string |
可选 |
comment_identity |
string |
可选 |
product |
string |
可选 |
product_spec |
string |
可选 |
is_comment |
bool |
可选 |
mall.CommentItemRep
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
created_at |
string |
可选 |
nick_name |
string |
可选 |
score |
int32 |
可选 |
comment |
string |
可选 |
reply |
string |
可选 |
product_identity |
string |
可选 |
store_identity |
string |
可选 |
spec_identity |
string |
可选 |
comment_identity |
string |
可选 |
list |
[]mall.CommentItem |
数组 |
product |
string |
可选 |
product_spec |
string |
可选 |
mall.CommentListReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
count |
int64 |
可选 |
data |
[]mall.CommentItemRep |
数组 |
mall.ConfigsReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
configs |
string |
可选 |
mall.DenyRegionItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
mall_identity |
string |
可选 |
title |
string |
可选 |
region |
[]mall.RegionItem |
数组 |
mall.DenyRegionReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
count |
int64 |
可选 |
data |
[]mall.DenyRegionItem |
数组 |
mall.DetailBySpecRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
spec_no |
string |
可选 |
mall.FreightAttrItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
freight_identity |
string |
可选 |
region_str |
string |
可选 |
region |
[]mall.RegionItem |
数组 |
price_basic |
int64 |
可选 |
count_basic |
int64 |
可选 |
count_extra |
int64 |
可选 |
price_extra |
int64 |
可选 |
status |
int32 |
可选 |
is_default |
int32 |
可选 |
mall.FreightItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
status |
int32 |
可选 |
title |
string |
可选 |
post_type |
int32 |
可选 |
quota |
int64 |
可选 |
cost_type |
int32 |
可选 |
region_type |
int32 |
可选 |
rules |
[]mall.FreightAttrItem |
数组 |
mall.FreightReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
count |
int64 |
可选 |
data |
[]mall.FreightItem |
数组 |
mall.LicensingRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
license_type |
string |
可选 |
license |
string |
可选 |
domain |
string |
可选 |
host |
string |
可选 |
ip |
string |
可选 |
mall.ListItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
product_id |
int64 |
可选 |
product |
string |
可选 |
spec_id |
int64 |
可选 |
spec |
string |
可选 |
spec_no |
string |
可选 |
price |
int64 |
可选 |
count |
int64 |
可选 |
img |
string |
可选 |
product_identity |
string |
可选 |
serial_id |
string |
可选 |
mall.ListReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
count |
int64 |
可选 |
data |
[]mall.ProductItem |
数组 |
mall.LoginReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
token |
string |
可选 |
identity |
string |
可选 |
store_identity |
string |
可选 |
name |
string |
可选 |
account |
string |
可选 |
role |
string |
可选 |
status |
int32 |
可选 |
created_at |
string |
可选 |
store_name |
string |
可选 |
mall.LoginRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
account |
string |
可选 |
password |
string |
可选 |
phone |
string |
可选 |
verify_code |
string |
可选 |
login_genre |
int32 |
可选 |
mall.MallSearchReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
list |
[]mall.StoreBasic |
数组 |
count |
int64 |
可选 |
mall.MallSearchRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
page_no |
int64 |
可选 |
page_size |
int64 |
可选 |
keyword |
string |
可选 |
mall.MiniCodeReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
img |
string |
可选 |
mall.MiniCodeRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
types |
string |
可选 |
mall.ModifyRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
identity |
string |
可选 |
status |
int32 |
可选 |
mall.NoticeItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
identity |
string |
可选 |
title |
string |
可选 |
content |
string |
可选 |
author |
string |
可选 |
store_id |
int64 |
可选 |
store_identity |
string |
可选 |
created_at |
string |
可选 |
status |
int64 |
可选 |
mall.NoticeListReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
data |
[]mall.NoticeItem |
数组 |
count |
int64 |
可选 |
mall.OpRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
identity |
[]string |
数组 |
status |
int32 |
可选 |
mall.PhotoItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
name |
string |
可选 |
identity |
string |
可选 |
product_identity |
string |
可选 |
url |
string |
可选 |
sort |
int32 |
可选 |
types |
string |
可选 |
id |
int64 |
可选 |
mall.PhotoReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
count |
int64 |
可选 |
data |
[]mall.PhotoItem |
数组 |
mall.ProductItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
supply_id |
int64 |
可选 |
category_id |
[]int64 |
数组 |
title |
string |
可选 |
measuring_name |
string |
可选 |
sell_max |
int64 |
可选 |
sell_min |
int64 |
可选 |
wastage |
int64 |
可选 |
standard_number |
string |
可选 |
brand |
string |
可选 |
stock_type |
int64 |
可选 |
status |
int32 |
可选 |
putaway_time |
string |
可选 |
cover_image |
string |
可选 |
content |
string |
可选 |
store_id |
int64 |
可选 |
store_identity |
string |
可选 |
template_id |
int32 |
可选 |
note |
string |
可选 |
images |
[]mall.PhotoItem |
数组 |
specification |
[]mall.SpecItem |
数组 |
recent_number |
int64 |
可选 |
sale_total |
int64 |
可选 |
created_at |
string |
可选 |
limitation |
int64 |
可选 |
liTemplate_id |
int64 |
可选 |
price |
int64 |
可选 |
stock |
int64 |
可选 |
category |
string |
可选 |
serial_id |
string |
可选 |
gas_types |
int64 |
可选 |
spec_id |
[]int64 |
数组 |
categories |
[]mall.CategoriesItem |
数组 |
supply_name |
string |
可选 |
mall.RegionItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int32 |
可选 |
name |
string |
可选 |
second |
[]mall.RegionItem |
数组 |
mall.SetAccountRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
account |
string |
可选 |
password |
string |
可选 |
password_confirmed |
string |
可选 |
mall.SettingRequest
| JSON 字段 | 类型 | 规则 |
|---|---|---|
identity |
string |
可选 |
configs |
string |
可选 |
mall.SpecItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
supply_id |
int64 |
可选 |
product_identity |
string |
可选 |
store_identity |
string |
可选 |
title |
string |
可选 |
stock_type |
int32 |
可选 |
stock |
int64 |
可选 |
price |
int64 |
可选 |
direct_sales |
int64 |
可选 |
tp_type |
int32 |
可选 |
ds_tp_type |
int32 |
可选 |
img |
string |
可选 |
spec_no |
string |
可选 |
keyword |
string |
可选 |
purchasing_price |
int64 |
可选 |
wholesale |
int64 |
可选 |
mall.SpecReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
count |
int64 |
可选 |
data |
[]mall.SpecItem |
数组 |
mall.StaffItem
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
name |
string |
可选 |
account |
string |
可选 |
password |
string |
可选 |
profile |
string |
可选 |
role |
string |
可选 |
phone |
string |
可选 |
email |
string |
可选 |
status |
int32 |
可选 |
avatar |
string |
可选 |
created_at |
string |
可选 |
mall.StaffListReply
| JSON 字段 | 类型 | 规则 |
|---|---|---|
data |
[]mall.StaffItem |
数组 |
count |
int64 |
可选 |
mall.StoreBasic
| JSON 字段 | 类型 | 规则 |
|---|---|---|
id |
int64 |
可选 |
identity |
string |
可选 |
logo |
string |
可选 |
title |
string |
可选 |
intro |
string |
可选 |
template |
string |
可选 |
configs |
string |
可选 |
subdomain |
string |
可选 |
created_at |
string |
可选 |
status |
int32 |
可选 |
keywords |
string |
可选 |
approve |
int32 |
可选 |