资料中台文档
1. 第三方集成
在开始集成之前,你需要先知晓资料中台的OpenAPI地址以及访问appId和秘钥。
第三方应用接入资料中台主要有两种形式:
-
直接调用资料中台提供的OpenAPI,通常有两种使用场景
-
第三方不存储数据,在数据发生时候直接访问资料中台获取数据
-
第三方存储数据,通过最后修改时间增量访问资料中台获取数据
-
-
通过数据订阅,指定订阅的主题,并传入一个符合资料中台规则的SPI接口地址,当资料中台的数据满足订阅的目标条件时,将会回调SPI接口地址,主题主要也是两种类型
-
通知型主题:将数据主键传给目标SPI,通常目标SPI需要先将通知存储下来,尽可能都接受通知,随后异步调度处理通知,通过调用资料中台的OpenAPI获取完整数据
-
数据型主题:将完整数据传给目标SPI,通过目标SPI需要实时处理数据,并返回处理结果给资料中台
-
大致的交互图如下所示:
1.1. 接口请求鉴权
访问资料中台的OpenAPI需要使用【base64】或者使用【JWT鉴权(HS256算法)】,随Http Header的Authorization参数发送。
示例(java):
-
base64 认证:
HttpHeaders headers = new HttpHeaders();
headers.set("Content-Type", "application/json");
String userPass = 请求用户 + ":" + 请求密码;
String basic = "Basic " + Base64Utils.encodeToString(userPass.getBytes());
headers.set("Authorization", basic);
HttpEntity<String> entity = new HttpEntity<String>(请求体, headers);
ResponseEntity<String> responseEntity = restTemplate.exchange(url, HttpMethod.POST, entity, String.class);
-
JWT鉴权(HS256算法) 认证:
HttpHeaders headers = new HttpHeaders();
headers.set("Content-Type", "application/json");
headers.set("Authorization", issueJwt(租户ID, 秘钥));
HttpEntity<String> entity = new HttpEntity<String>(请求体, headers);
ResponseEntity<String> responseEntity = restTemplate.exchange(url, HttpMethod.POST, entity, String.class);
/**
* 生成新的token。
*/
private String issueJwt(String tenant, String secret) {
Map<String, Object> claims = new HashMap<>();
claims.put("tenant", tenant); //请求的租户ID
// JWT签名设置
JWTSigner.Options options = new JWTSigner.Options().setAlgorithm(Algorithm.HS256);
options.setIssuedAt(true);
// 签名
JWTSigner signer = new JWTSigner(secret);
String jwt = signer.sign(claims, options);
return jwt;
}
1.2. 数据订阅
TODO,待合并,基本同鼎力云数据订阅接口
1.3. 回调地址
在订阅时候,需要提供SPI回调地址。回调接口使用HTTP RESFUL接口实现,支持HTTP和HTTPS协议,鉴权支持JWT和BASIC两种认证方式,需要在订阅售时指定,
1.4. 数据主题
当前可订阅的数据主题
主题分组 | 主题ID | 描述 | 触发动作列表 | 触发时机 |
---|---|---|---|---|
platform_category |
platform_category.changed |
平台分类主题 |
create(新建),update(编辑),delete(删除) |
新增或编辑推送平台分类列表到SPI |
platform_category |
platform_category.changed.notify |
平台分类通知主题 |
create(新建),update(编辑) |
推送新增或编辑的平台分类ID列表到SPI |
platform_sku |
platform_sku.changed |
平台商品主题 |
create(新建),update(编辑) |
新增或编辑推送平台商品列表到SPI |
platform_sku |
platform_sku.changed.notify |
平台商品通知主题 |
create(新建),update(编辑) |
新增或编辑推送平台商品列表到SPI |
platform_shop |
platform_shop.changed |
平台门店主题 |
create(新建),update(编辑),delete(删除) |
新增、编辑或删除推送平台门店列表到SPI |
platform_shop |
platform_shop.changed.notify |
平台门店通知主题 |
create(新建),update(编辑),delete(删除) |
新增、编辑或删除推送平台门店列表到SPI |
platform_shop_sku |
platform_shop_sku.changed |
门店平台商品主题 |
create(新建),update(编辑),putOn(上架),putOff(下架),saleOut(售罄) |
新增或编辑推送门店平台商品列表到SPI |
platform_shop_sku |
platform_shop_sku.changed.notify |
门店平台商品通知主题 |
create(新建),putOn(上架),putOff(下架) |
推送新增或编辑的门店平台商品ID列表到SPI |
platform_shop_front_sku |
platform_shop_front_sku.changed |
门店平台前台商品主题 |
create(新建),putOn(上架),putOff(下架) |
新增或编辑推送门店平台前台商品列表到SPI |
platform_shop_front_sku |
platform_shop_front_sku.changed.notify |
门店平台前台商品通知主题 |
create(新建),putOn(上架),putOff(下架) |
新增或编辑推送门店平台前台商品列表到SPI |
platform_front_spu |
platform_front_spu.changed |
平台前台Spu主题 |
update, delete |
编辑推送门店前台Spu列表到SPI |
platform_front_spu |
platform_front_spu.changed.notify |
平台前台Spu通知主题 |
update, delete |
编辑推送门店前台Spu列表到SPI |
1.4.1. 平台店内分类通知消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_category", // 消息分组
"topic": "platform_category.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"tenantId":"", // 租户id
"platformId":"", // 平台id
"categoryId":"", // 分类id
"type":"", // 类型
"action":"" // 动作new, update, delete
}
1.4.2. 平台店内分类消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_category", // 消息分组
"topic": "platform_category.changed", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"platform_category":{}, // 见OpenAPI接口“平台门店分类”数据格式
"action":"" // 动作new, update, delete
}
1.4.3. 平台商品通知消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_sku", // 消息分组
"topic": "platform_sku.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"tenantId":"", // 租户id
"platformId":"", // 平台id
"id":"", // 前台商品ID(FrontSkuId)(历史遗留问题,不建议使用)
"id2":"", // 平台前台商品id
"frontSkuId":"", // 前台商品id
"action":"" // 动作new, update
}
1.4.4. 平台商品消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_sku", // 消息分组
"topic": "platform_sku.changed", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"platform_sku":{}, // 见OpenAPI接口“平台前台sku”数据格式
"action":"" // 动作new, update
}
1.4.5. 平台门店通知消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_shop", // 消息分组
"topic": "platform_shop.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"tenantId":"", // 租户id
"id":"", // 平台门店id
"action":"" // 动作create, update, delete
}
1.4.6. 平台门店消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_shop", // 消息分组
"topic": "platform_shop.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"platform_shop": {}, // 见OpenAPI接口数据格式
"action":"" // 动作create, update, delete
}
1.4.7. 门店平台商品通知消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_shop_sku", // 消息分组
"topic": "platform_shop_sku.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"tenantId":"", // 租户id
"platformId":"", // 平台id
"shopId":"", // 门店id
"skuId":"", // skuId
"action":"" // 动作new, update, delete,setIsSale
}
1.4.8. 门店平台商品消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_shop_sku", // 消息分组
"topic": "platform_shop_sku.changed", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"platform_shop_sku":{},// 见OpenAPI接口数据格式
"action":"" // 动作new, update, delete
}
1.4.9. 门店平台前台商品通知消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_shop_front_sku", // 消息分组
"topic": "platform_shop_front_sku.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"tenantId":"", // 租户id
"platformId":"", // 平台id
"shopId":"", // 门店id
"frontSkuId":"", // 前台SkuId
"action":"" // 动作create, update, delete, putOn, putOff
}
1.4.10. 门店平台前台商品消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_shop_front_sku", // 消息分组
"topic": "platform_shop_front_sku.changed", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"platform_shop_front_sku":{},// 见OpenAPI接口数据格式
"action":"" // 动作create, update, delete, putOn, putOff
}
1.4.11. 平台前台Spu通知消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_front_spu", // 消息分组
"topic": "platform_front_spu.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳}// data 数据结构
{
"tenantId":"", // 租户id
"platformId":"", // 平台id
"spuId":"", // 门店id
"action":"" // 动作 update, delete
}
1.4.12. 平台前台Spu消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_front_spu", // 消息分组
"topic": "platform_front_spu.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳}// data 数据结构
{
"tenantId":"", // 租户id
"platformId":"", // 平台id
"spuId":"", // 门店id
"action":"" // 动作 update, delete
}
1.5. 平台分类前台spu消息
{
"id": "4028fe8153b876e50153b8779b2a0001", // 消息id
"group": "platform_category_front_spu", // 消息分组
"topic": "platform_category_front_spu.changed.notify", // 消息主题
"content": "{data:[...]}", // 消息内容
"time": 5211212555 // 消息时间戳
}
// data 数据结构
{
"tenantId":"", // 租户id
"platformId":"", // 平台id
"categoryId":"", // 分类id
"groupId":"", // 分组id(承载shopId)
"action":"", // 动作new, update, delete
"type":"" // 类型front,back,cover
}
Api Documentation
1. 概览
Api Documentation
1.1. 版本信息
版本 : 1.0
1.2. 许可信息
许可证 : Apache 2.0
许可网址 : http://www.apache.org/licenses/LICENSE-2.0
服务条款 : urn:tos
1.3. URI scheme
域名 : 47.98.194.220:8014
基础路径 : /
1.4. 标签
-
PRIVATE:系统信息 : About Controller
-
sku服务 : Sku Controller
-
spu服务 : Spu Controller
-
内容修饰 : Content Decorator Controller
-
内容投放 : Content Delivery Controller
-
内容资源位 : Content Place Controller
-
分类 : Category Controller
-
品牌 : Brand Controller
-
地址库 : Address Controller
-
平台前台sku服务 : Platform Front Sku Controller
-
平台类目 : Platform Category Controller
-
平台类目商品 : Platform Category Sku Controller
-
平台门店 : Platform Shop Controller
-
平台门店分类 : Platform Shop Category Controller
-
平台门店商品 : Platform Shop Sku Controller
-
排序规则 : Sort Rule Controller
-
搜索热词 : Hotword Controller
-
数据归档 : Source Controller
-
活动模板 : Content Template Controller
-
索引服务 : Index Controller
-
角标 : Badge Controller
-
选项 : Options Controller
-
配送方式&配送费配置 : Delivery Controller
-
门店 : Shop Controller
-
门店商品 : Shop Sku Controller
-
门店商品价格 : Shop Sku Price Controller
-
门店商品库存 : Shop Sku Inv Controller
2. 资源
2.1. PRIVATE:系统信息
About Controller
2.1.1. about
GET /about
2.1.1.1. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.1.1.3. HTTP请求示例
请求 path
/about
2.1.1.4. HTTP响应示例
响应 200
{
"build" : "string",
"commonTitle" : "string",
"copyright" : "string",
"groupId" : "string",
"localeTitle" : "string",
"site" : "string",
"title" : "string",
"version" : {
"build" : [ "string" ],
"buildText" : "string",
"empty" : true,
"major" : [ "string" ],
"majorText" : "string",
"milestone" : [ "string" ],
"milestoneText" : "string",
"s" : [ "string" ],
"text" : "string"
}
}
2.2. Sku服务
Sku Controller
2.2.1. 查询sku列表
POST /v2/{tenant}/service/sku/query
2.2.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
query filter |
2.2.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.2.1.3. 消耗
-
application/json
2.2.1.4. 生成
-
application/json;charset=utf-8
2.2.1.5. HTTP请求示例
请求 path
/v2/string/service/sku/query
请求 body
{
"brandNameLike" : "string",
"businessTypeEq" : "string",
"categoryIdIn" : [ "string" ],
"codeEq" : "string",
"codeIn" : [ "string" ],
"codeLike" : "string",
"comboSkuIdIn" : [ "string" ],
"comboSkuIdLike" : "string",
"comboTypeEq" : "string",
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"firstSaleGt" : "string",
"firstSaleLt" : "string",
"goodsIdIn" : [ "string" ],
"goodsIdLike" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"idLike" : "string",
"idNotIn" : [ "string" ],
"image" : true,
"inputCodeCodeEq" : "string",
"inputCodeCodeIn" : [ "string" ],
"inputCodeCodeStartWith" : "string",
"inputCodeQpcEq" : 0.0,
"inputCodeQpcNotEq" : 0.0,
"inputCodeTypeEq" : "string",
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"nameLike" : "string",
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"qualifiedEq" : true,
"saleStatusEq" : "string",
"saleTypeEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"spuIdEq" : "string",
"typeEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.2.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0,
"mbrPrice" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0,
"mbrPrice" : 0.0
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.2.2. 获取指定SKU信息
GET /v2/{tenant}/service/sku/{orgType}/{orgId}/{id}
2.2.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
tenant |
string |
2.2.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.2.2.3. 生成
-
application/json;charset=utf-8
2.2.2.4. HTTP请求示例
请求 path
/v2/string/service/sku/string/string/string
2.2.2.5. HTTP响应示例
响应 200
{
"data" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0,
"mbrPrice" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0,
"mbrPrice" : 0.0
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.2.3. 根据skuId获取单规格商品
GET /v2/{tenant}/service/sku/{orgType}/{orgId}/{id}/miniQpcSku
2.2.3.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
tenant |
string |
2.2.3.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.2.3.3. 生成
-
application/json;charset=utf-8
2.2.3.4. HTTP请求示例
请求 path
/v2/string/service/sku/string/string/string/miniQpcSku
2.2.3.5. HTTP响应示例
响应 200
{
"data" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0,
"mbrPrice" : 0.0
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.3. Spu服务
Spu Controller
2.3.1. 查询spu列表
POST /v2/{tenant}/service/spu/query
2.3.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
spu查询条件 |
2.3.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.3.1.3. 消耗
-
application/json
2.3.1.4. 生成
-
application/json;charset=utf-8
2.3.1.5. HTTP请求示例
请求 path
/v2/string/service/spu/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"idLike" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"nameLike" : "string",
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"skuContains" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.3.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"values" : [ "string" ]
} ],
"skus" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.3.2. 获取指定Spu信息
GET /v2/{tenant}/service/spu/{orgType}/{orgId}/{id}
2.3.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
tenant |
string |
2.3.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.3.2.3. 生成
-
application/json;charset=utf-8
2.3.2.4. HTTP请求示例
请求 path
/v2/string/service/spu/string/string/string
2.3.2.5. HTTP响应示例
响应 200
{
"data" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"values" : [ "string" ]
} ],
"skus" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.4. 内容修饰
Content Decorator Controller
2.4.1. query
POST /v2/{tenant}/service/content/decorator/query
2.4.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户id |
string |
Body |
filter |
角标 |
2.4.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.4.1.3. 消耗
-
application/json
2.4.1.4. 生成
-
application/json;charset=utf-8
2.4.1.5. HTTP请求示例
请求 path
/v2/string/service/content/decorator/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"dateBeginGtEq" : "string",
"dateBeginLt" : "string",
"dateBeginLtEq" : "string",
"dateEndGtEq" : "string",
"dateEndLt" : "string",
"dateEndLtEq" : "string",
"deletedEq" : true,
"enableEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"skuIdIn" : [ "string" ],
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.4.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"beginDate" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"endDate" : "string",
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"lines" : [ {
"badgeId" : "string",
"badgePlatformIds" : [ "string" ],
"isEnableBadge" : true,
"isEnablePrefix" : true,
"prefixs" : [ "string" ],
"shopIds" : [ "string" ],
"skuId" : "string"
} ],
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.4.2. get
GET /v2/{tenant}/service/content/decorator/{orgType}/{orgId}/{id}
2.4.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
指定id |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
租户id |
string |
2.4.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.4.2.3. 生成
-
application/json;charset=utf-8
2.4.2.4. HTTP请求示例
请求 path
/v2/string/service/content/decorator/string/string/string
2.4.2.5. HTTP响应示例
响应 200
{
"data" : {
"beginDate" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"endDate" : "string",
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"lines" : [ {
"badgeId" : "string",
"badgePlatformIds" : [ "string" ],
"isEnableBadge" : true,
"isEnablePrefix" : true,
"prefixs" : [ "string" ],
"shopIds" : [ "string" ],
"skuId" : "string"
} ],
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.5. 内容投放
Content Delivery Controller
2.5.1. query
POST /v2/{tenant}/service/content/delivery/query
2.5.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户id |
string |
Body |
filter |
投放内容 |
2.5.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.5.1.3. 消耗
-
application/json
2.5.1.4. 生成
-
application/json;charset=utf-8
2.5.1.5. HTTP请求示例
请求 path
/v2/string/service/content/delivery/query
请求 body
{
"dateBeginLt" : "string",
"dateEndGtEq" : "string",
"enable" : true,
"fetchParts" : "string",
"hourBeginLtEq" : 0,
"hourEndGtEq" : 0,
"minuteBeginLtEq" : 0,
"minuteEndGtEq" : 0,
"page" : 0,
"pageSize" : 0,
"placeIdEq" : "string",
"placeIdIn" : [ "string" ],
"placeNoEq" : 0,
"platformIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ]
}
2.5.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"begin" : "string",
"countDown" : true,
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"cycle" : true,
"cycleConditions" : [ {
"hourBegin" : 0,
"hourEnd" : 0,
"minuteBegin" : 0,
"minuteEnd" : 0,
"orderNo" : 0
} ],
"deleted" : true,
"enabled" : true,
"end" : "string",
"id" : "string",
"image" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"pageParams" : "object",
"placeId" : "string",
"placeNo" : 0,
"platformId" : "string",
"remark" : "string",
"stayTime" : 0,
"targetPage" : "string",
"targetType" : "string",
"targets" : [ "string" ],
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.5.2. get
GET /v2/{tenant}/service/content/delivery/{id}
2.5.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
指定id |
string |
Path |
tenant |
租户id |
string |
2.5.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.5.2.3. 生成
-
application/json;charset=utf-8
2.5.2.4. HTTP请求示例
请求 path
/v2/string/service/content/delivery/string
2.5.2.5. HTTP响应示例
响应 200
{
"data" : {
"begin" : "string",
"countDown" : true,
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"cycle" : true,
"cycleConditions" : [ {
"hourBegin" : 0,
"hourEnd" : 0,
"minuteBegin" : 0,
"minuteEnd" : 0,
"orderNo" : 0
} ],
"deleted" : true,
"enabled" : true,
"end" : "string",
"id" : "string",
"image" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"pageParams" : "object",
"placeId" : "string",
"placeNo" : 0,
"platformId" : "string",
"remark" : "string",
"stayTime" : 0,
"targetPage" : "string",
"targetType" : "string",
"targets" : [ "string" ],
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.6. 内容资源位
Content Place Controller
2.6.1. query
POST /v2/{tenant}/service/content/place/query
2.6.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户id |
string |
Body |
filter |
筛选项 |
2.6.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.6.1.3. 消耗
-
application/json
2.6.1.4. 生成
-
application/json;charset=utf-8
2.6.1.5. HTTP请求示例
请求 path
/v2/string/service/content/place/query
请求 body
{
"createGt" : "string",
"createLt" : "string",
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"placeIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"updateGt" : "string",
"updateLt" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.6.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"channel" : "string",
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"imageUrl" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orderNo" : 0,
"platformId" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.6.2. get
GET /v2/{tenant}/service/content/place/{id}
2.6.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
指定查询id |
string |
Path |
tenant |
租户id |
string |
2.6.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.6.2.3. 生成
-
application/json;charset=utf-8
2.6.2.4. HTTP请求示例
请求 path
/v2/string/service/content/place/string
2.6.2.5. HTTP响应示例
响应 200
{
"data" : {
"channel" : "string",
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"imageUrl" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orderNo" : 0,
"platformId" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.7. 分类
Category Controller
2.7.1. 查询分类
POST /v2/{tenant}/service/category/query
2.7.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.7.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.7.1.3. 消耗
-
application/json
2.7.1.4. 生成
-
application/json;charset=utf-8
2.7.1.5. HTTP请求示例
请求 path
/v2/string/service/category/query
请求 body
{
"codeEq" : "string",
"codeIn" : [ "string" ],
"codeLike" : "string",
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"nameLike" : "string",
"page" : 0,
"pageSize" : 0,
"pathStartWidth" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"upperEq" : "string",
"upperIn" : [ "string" ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.7.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.7.2. 获取指定分类
GET /v2/{tenant}/service/category/{orgType}/{orgId}/{id}
2.7.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
tenant |
string |
2.7.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.7.2.3. 生成
-
application/json;charset=utf-8
2.7.2.4. HTTP请求示例
请求 path
/v2/string/service/category/string/string/string
2.7.2.5. HTTP响应示例
响应 200
{
"data" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.8. 品牌
Brand Controller
2.8.1. 查询品牌
POST /v2/{tenant}/service/brand/query
2.8.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.8.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.8.1.3. 消耗
-
application/json
2.8.1.4. 生成
-
application/json;charset=utf-8
2.8.1.5. HTTP请求示例
请求 path
/v2/string/service/brand/query
请求 body
{
"codeEq" : "string",
"codeStartWith" : "string",
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"modifiedGt" : "string",
"modifiedLt" : "string",
"nameLike" : "string",
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"upperEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.8.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.8.2. 获取指定品牌
GET /v2/{tenant}/service/brand/{orgType}/{orgId}/{id}
2.8.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
tenant |
string |
2.8.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.8.2.3. 生成
-
application/json;charset=utf-8
2.8.2.4. HTTP请求示例
请求 path
/v2/string/service/brand/string/string/string
2.8.2.5. HTTP响应示例
响应 200
{
"data" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.9. 地址库
Address Controller
2.9.1. 查询地址
POST /v2/{tenant}/service/address/query
2.9.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.9.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.9.1.3. 消耗
-
application/json
2.9.1.4. 生成
-
application/json;charset=utf-8
2.9.1.5. HTTP请求示例
请求 path
/v2/string/service/address/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"desc" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"levelEq" : 0,
"modifiedGt" : "string",
"modifiedLt" : "string",
"nameEq" : "string",
"orgTypeInclude" : "string",
"page" : 0,
"pageSize" : 0,
"sortKey" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"upperEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.9.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"childrens" : [ {
"childrens" : [ "..." ],
"id" : "string",
"level" : 0,
"name" : "string",
"pinyin" : "string",
"upper" : "string",
"uuid" : "string"
} ],
"id" : "string",
"level" : 0,
"name" : "string",
"pinyin" : "string",
"upper" : "string",
"uuid" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.10. 平台前台sku服务
Platform Front Sku Controller
2.10.1. 查询平台前台sku列表
POST /v2/{tenant}/service/platformfrontsku/query
2.10.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
平台前台sku查询条件 |
2.10.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.10.1.3. 消耗
-
application/json
2.10.1.4. 生成
-
application/json;charset=utf-8
2.10.1.5. HTTP请求示例
请求 path
/v2/string/service/platformfrontsku/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"frontSkuIdEq" : "string",
"frontSkuIdIn" : [ "string" ],
"idEq" : "string",
"idIn" : [ "string" ],
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"platformIdEq" : "string",
"platformIdIn" : [ "string" ],
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.10.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"frontSkuId" : "string",
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"platformId" : "string",
"sku" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
},
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.10.2. 获取指定平台前台sku信息
GET /v2/{tenant}/service/platformfrontsku/{id}
2.10.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
2.10.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.10.2.3. 生成
-
application/json;charset=utf-8
2.10.2.4. HTTP请求示例
请求 path
/v2/string/service/platformfrontsku/string
2.10.2.5. HTTP响应示例
响应 200
{
"data" : {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"frontSkuId" : "string",
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"platformId" : "string",
"sku" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
},
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.11. 平台类目
Platform Category Controller
2.11.1. 查询类目
POST /v2/{tenant}/service/platformcategory/query
2.11.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.11.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.11.1.3. 消耗
-
application/json
2.11.1.4. 生成
-
application/json;charset=utf-8
2.11.1.5. HTTP请求示例
请求 path
/v2/string/service/platformcategory/query
请求 body
{
"codeIn" : [ "string" ],
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"modifiedGt" : "string",
"modifiedLt" : "string",
"nameEq" : "string",
"nameIn" : [ "string" ],
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"pathStartWith" : "string",
"platformIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"typeEq" : "string",
"upperIdEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.11.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"children" : [ {
"children" : [ "..." ],
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"image" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"platformId" : "string",
"sort" : 0,
"tenant" : "string",
"type" : "string",
"upperId" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"image" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"platformId" : "string",
"sort" : 0,
"tenant" : "string",
"type" : "string",
"upperId" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.12. 平台类目商品
Platform Category Sku Controller
2.12.1. 查询平台类目商品
POST /v2/{tenant}/service/platformcategorysku/query
2.12.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.12.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.12.1.3. 消耗
-
application/json
2.12.1.4. 生成
-
application/json;charset=utf-8
2.12.1.5. HTTP请求示例
请求 path
/v2/string/service/platformcategorysku/query
请求 body
{
"fetchParts" : "string",
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"platformCategoryIdEq" : "string",
"platformCategoryIdIn" : [ "string" ],
"platformCategoryTypeEq" : "string",
"platformCategoryTypeIn" : [ "string" ],
"platformIdEq" : "string",
"platformIdIn" : [ "string" ],
"skuIdIn" : [ "string" ],
"skuIdLike" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ]
}
2.12.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"orgId" : "string",
"orgType" : "string",
"platformCategoryId" : "string",
"platformCategoryType" : "string",
"platformId" : "string",
"skuId" : "string",
"sort" : 0,
"tenant" : "string",
"uuid" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.13. 平台门店
Platform Shop Controller
2.13.1. 查询平台门店分页列表
POST /v2/{tenant}/service/platformShop/query
2.13.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.13.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.13.1.3. 消耗
-
application/json
2.13.1.4. 生成
-
application/json;charset=utf-8
2.13.1.5. HTTP请求示例
请求 path
/v2/string/service/platformShop/query
请求 body
{
"businessStateEq" : "string",
"cityIdEq" : "string",
"codeEq" : "string",
"codeIdIn" : [ "string" ],
"codeStartWith" : "string",
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"hasAssociateShop" : true,
"idEq" : "string",
"idIn" : [ "string" ],
"keyLike" : "string",
"merchantCodeIn" : [ "string" ],
"merchantCodeStartWith" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"platformIdEq" : "string",
"shopCodeIn" : [ "string" ],
"shopCodeStartWith" : "string",
"shopIdEq" : "string",
"shopIdIn" : [ "string" ],
"shopIdLike" : "string",
"shopNameLike" : "string",
"shopTypeEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"stateEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.13.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"associateShop" : {
"address" : {
"cityId" : "string",
"cityName" : "string",
"country" : "string",
"detailAddress" : "string",
"districtId" : "string",
"districtName" : "string",
"latitude" : "string",
"longitude" : "string",
"postcode" : "string",
"provinceId" : "string",
"provinceName" : "string",
"streetId" : "string",
"streetName" : "string"
},
"businessCircles" : [ "string" ],
"businessHour" : "string",
"code" : "string",
"complainPhoneHour" : "string",
"complainPhoneNumber" : "string",
"configs" : {
"string" : "string"
},
"contact" : {
"email" : "string",
"fax" : "string",
"mobile" : "string",
"name" : "string",
"telephone" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"facadeImage" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"level" : "string",
"name" : "string",
"remaindPhoneNumber" : "string",
"servicePhoneNumber" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"businessHour" : [ "string" ],
"businessState" : "string",
"code" : "string",
"configs" : {
"string" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"name" : "string",
"platform" : {
"id" : "string",
"name" : "string"
},
"state" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.13.2. 获取指定平台门店
GET /v2/{tenant}/service/platformShop/{id}
2.13.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
2.13.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.13.2.3. 生成
-
application/json;charset=utf-8
2.13.2.4. HTTP请求示例
请求 path
/v2/string/service/platformShop/string
2.13.2.5. HTTP响应示例
响应 200
{
"data" : {
"associateShop" : {
"address" : {
"cityId" : "string",
"cityName" : "string",
"country" : "string",
"detailAddress" : "string",
"districtId" : "string",
"districtName" : "string",
"latitude" : "string",
"longitude" : "string",
"postcode" : "string",
"provinceId" : "string",
"provinceName" : "string",
"streetId" : "string",
"streetName" : "string"
},
"businessCircles" : [ "string" ],
"businessHour" : "string",
"code" : "string",
"complainPhoneHour" : "string",
"complainPhoneNumber" : "string",
"configs" : {
"string" : "string"
},
"contact" : {
"email" : "string",
"fax" : "string",
"mobile" : "string",
"name" : "string",
"telephone" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"facadeImage" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"level" : "string",
"name" : "string",
"remaindPhoneNumber" : "string",
"servicePhoneNumber" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"businessHour" : [ "string" ],
"businessState" : "string",
"code" : "string",
"configs" : {
"string" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"name" : "string",
"platform" : {
"id" : "string",
"name" : "string"
},
"state" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.14. 平台门店分类
Platform Shop Category Controller
2.14.1. 查询指定类型的分类
POST /v2/{tenant}/service/platformShopCategory/{platformId}/{shopId}/query
2.14.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
platformId |
platformId |
string |
Path |
shopId |
shopId |
string |
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.14.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.14.1.3. 消耗
-
application/json
2.14.1.4. 生成
-
application/json;charset=utf-8
2.14.1.5. HTTP请求示例
请求 path
/v2/string/service/platformShopCategory/string/string/query
请求 body
{
"codeEq" : "string",
"codeIn" : [ "string" ],
"fetchParts" : "string",
"hasSku" : true,
"idEq" : "string",
"keyword" : "string",
"upperEq" : "string"
}
2.14.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"children" : [ {
"children" : [ "..." ],
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"path" : "string",
"platformId" : "string",
"shopId" : "string",
"sort" : 0,
"tenant" : "string",
"type" : "string",
"upperId" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"path" : "string",
"platformId" : "string",
"shopId" : "string",
"sort" : 0,
"tenant" : "string",
"type" : "string",
"upperId" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.15. 平台门店商品
Platform Shop Sku Controller
2.15.1. 查询平台门店商品
POST /v2/{tenant}/service/platformShopSku/query
2.15.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.15.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.15.1.3. 消耗
-
application/json
2.15.1.4. 生成
-
application/json;charset=utf-8
2.15.1.5. HTTP请求示例
请求 path
/v2/string/service/platformShopSku/query
请求 body
{
"attachFilter" : {
"conditions" : [ {
"field" : "string",
"operator" : "string",
"parameters" : [ "object" ]
} ],
"unionConditions" : [ {
"orConditions" : [ {
"field" : "string",
"operator" : "string",
"parameters" : [ "object" ]
} ]
} ]
},
"brandIdIn" : [ "string" ],
"brandIdNotIn" : [ "string" ],
"categoryIdIn" : [ "string" ],
"categoryIdNotIn" : [ "string" ],
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"enabledEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"platformCategoryIdEq" : "string",
"platformCategoryIdIn" : [ "string" ],
"platformIdEq" : "string",
"priceRange" : [ 0.0 ],
"shopCodeEq" : "string",
"shopIdEq" : "string",
"shopIdIn" : [ "string" ],
"skuCodeEq" : "string",
"skuFetchParts" : "string",
"skuIdIn" : [ "string" ],
"skuIdNotIn" : [ "string" ],
"skuInputCodeCodeEq" : "string",
"skuInputCodeCodeIn" : [ "string" ],
"skuSaleStatusEq" : "string",
"skuSpuIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"upperPlatformCategoryIdEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.15.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"attach" : {
"fields" : "object",
"id" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"platform" : {
"id" : "string",
"name" : "string"
},
"saleStatus" : true,
"shop" : {
"id" : "string",
"name" : "string"
},
"sku" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
},
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.15.2. 索引查询平台门店商品
POST /v2/{tenant}/service/platformShopSku/search
2.15.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.15.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.15.2.3. 消耗
-
application/json
2.15.2.4. 生成
-
application/json;charset=utf-8
2.15.2.5. HTTP请求示例
请求 path
/v2/string/service/platformShopSku/search
请求 body
{
"conditions" : [ {
"field" : "string",
"operator" : "string",
"parameters" : [ "object" ]
} ],
"page" : 0,
"pageSize" : 0,
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"unionConditions" : [ {
"orConditions" : [ {
"field" : "string",
"operator" : "string",
"parameters" : [ "object" ]
} ]
} ]
}
2.15.2.6. HTTP响应示例
响应 200
{
"data" : [ {
"attach" : {
"fields" : "object",
"id" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"platform" : {
"id" : "string",
"name" : "string"
},
"saleStatus" : true,
"shop" : {
"id" : "string",
"name" : "string"
},
"sku" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
},
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.15.3. 获取指定id的平台门店商品
GET /v2/{tenant}/service/platformShopSku/{id}
2.15.3.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
2.15.3.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.15.3.3. 生成
-
application/json;charset=utf-8
2.15.3.4. HTTP请求示例
请求 path
/v2/string/service/platformShopSku/string
2.15.3.5. HTTP响应示例
响应 200
{
"data" : {
"attach" : {
"fields" : "object",
"id" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"platform" : {
"id" : "string",
"name" : "string"
},
"saleStatus" : true,
"shop" : {
"id" : "string",
"name" : "string"
},
"sku" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
},
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.16. 排序规则
Sort Rule Controller
2.16.1. 查询排序规则
POST /v2/{tenant}/service/sortrule/query
2.16.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.16.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.16.1.3. 消耗
-
application/json
2.16.1.4. 生成
-
application/json;charset=utf-8
2.16.1.5. HTTP请求示例
请求 path
/v2/string/service/sortrule/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"dataTypeEq" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"platformIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.16.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"dataKey" : "string",
"dataType" : "string",
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"orgId" : "string",
"orgType" : "string",
"platformId" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.17. 搜索热词
Hotword Controller
2.17.1. 查询热词
POST /v2/{tenant}/service/hotwords/query
2.17.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.17.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.17.1.3. 消耗
-
application/json
2.17.1.4. 生成
-
application/json;charset=utf-8
2.17.1.5. HTTP请求示例
请求 path
/v2/string/service/hotwords/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"dateBeginGtEq" : "string",
"dateBeginLt" : "string",
"dateBeginLtEq" : "string",
"dateEndGtEq" : "string",
"dateEndLt" : "string",
"dateEndLtEq" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"placeEq" : "string",
"platformIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"stateEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.17.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"begin" : "string",
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"end" : "string",
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"orgId" : "string",
"orgType" : "string",
"places" : [ "string" ],
"platformIds" : [ "string" ],
"skuIds" : [ "string" ],
"sort" : 0,
"state" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string",
"word" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.18. 数据归档
Source Controller
2.18.1. 查询数据归档
POST /v2/{tenant}/commons/service/source/query
2.18.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.18.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.18.1.3. 消耗
-
application/json
2.18.1.4. 生成
-
application/json;charset=utf-8
2.18.1.5. HTTP请求示例
请求 path
/v2/string/commons/service/source/query
请求 body
{
"bizKeyEq" : "string",
"bizKeyIn" : [ "string" ],
"bizKeyNotIn" : [ "string" ],
"contentIn" : [ {
"key" : "string",
"value" : "string"
} ],
"contentLike" : [ {
"key" : "string",
"value" : "string"
} ],
"fetchParts" : "string",
"keywordEq" : [ {
"key" : "string",
"value" : "string"
} ],
"page" : 0,
"pageSize" : 0,
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"typeEq" : "string"
}
2.18.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"businessKey" : "string",
"content" : "object",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.19. 活动模板
Content Template Controller
2.19.1. query
POST /v2/{tenant}/service/content/template/query
2.19.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户id |
string |
Body |
filter |
筛选条件 |
2.19.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.19.1.3. 消耗
-
application/json
2.19.1.4. 生成
-
application/json;charset=utf-8
2.19.1.5. HTTP请求示例
请求 path
/v2/string/service/content/template/query
请求 body
{
"createGt" : "string",
"createLt" : "string",
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"placeIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"updateGt" : "string",
"updateLt" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.19.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"content" : "object",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"image" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"placeId" : "string",
"remark" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.19.2. get
GET /v2/{tenant}/service/content/template/{id}
2.19.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
筛选条件id |
string |
Path |
tenant |
租户id |
string |
2.19.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.19.2.3. 生成
-
application/json;charset=utf-8
2.19.2.4. HTTP请求示例
请求 path
/v2/string/service/content/template/string
2.19.2.5. HTTP响应示例
响应 200
{
"data" : {
"content" : "object",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"image" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"placeId" : "string",
"remark" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.20. 索引服务
Index Controller
2.20.1. 添加文档
POST /v2/{tenant}/service/index/doc/add
2.20.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
request |
文档 |
2.20.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.20.1.3. 消耗
-
application/json
2.20.1.4. 生成
-
application/json;charset=utf-8
2.20.1.5. HTTP请求示例
请求 path
/v2/string/service/index/doc/add
请求 body
{
"data" : [ {
"fields" : "object",
"id" : "string",
"index" : "string",
"type" : "string"
} ]
}
2.20.1.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.20.2. 删除文档
POST /v2/{tenant}/service/index/doc/remove
2.20.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
request |
文档 |
2.20.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.20.2.3. 消耗
-
application/json
2.20.2.4. 生成
-
application/json;charset=utf-8
2.20.2.5. HTTP请求示例
请求 path
/v2/string/service/index/doc/remove
请求 body
{
"docIds" : [ "string" ],
"index" : "string",
"type" : "string"
}
2.20.2.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.20.3. 更新文档
POST /v2/{tenant}/service/index/doc/update
2.20.3.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
request |
文档 |
2.20.3.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.20.3.3. 消耗
-
application/json
2.20.3.4. 生成
-
application/json;charset=utf-8
2.20.3.5. HTTP请求示例
请求 path
/v2/string/service/index/doc/update
请求 body
{
"data" : [ {
"fields" : "object",
"id" : "string",
"index" : "string",
"type" : "string"
} ]
}
2.20.3.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.20.4. 搜索
POST /v2/{tenant}/service/index/search
2.20.4.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
request |
搜索条件 |
2.20.4.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.20.4.3. 消耗
-
application/json
2.20.4.4. 生成
-
application/json;charset=utf-8
2.20.4.5. HTTP请求示例
请求 path
/v2/string/service/index/search
请求 body
{
"collapse" : "object",
"conditions" : [ {
"field" : "string",
"operator" : "string",
"parameters" : [ "object" ]
} ],
"fields" : [ "string" ],
"index" : "string",
"page" : 0,
"pageSize" : 0,
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"type" : "string",
"unionConditions" : [ {
"orConditions" : [ {
"field" : "string",
"operator" : "string",
"parameters" : [ "object" ]
} ]
} ]
}
2.20.4.6. HTTP响应示例
响应 200
{
"documents" : [ {
"fields" : "object",
"id" : "string",
"index" : "string",
"type" : "string"
} ],
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"total" : 0
}
2.20.5. 根据id获取文档
GET /v2/{tenant}/service/index/{index}/{type}/{id}/get
2.20.5.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
index |
index |
string |
Path |
tenant |
tenant |
string |
Path |
type |
type |
string |
2.20.5.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.20.5.3. 生成
-
application/json;charset=utf-8
2.20.5.4. HTTP请求示例
请求 path
/v2/string/service/index/string/string/string/get
2.20.5.5. HTTP响应示例
响应 200
{
"data" : {
"fields" : "object",
"id" : "string",
"index" : "string",
"type" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.21. 角标
Badge Controller
2.21.1. query
POST /v2/{tenant}/service/badge/query
2.21.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户id |
string |
Body |
filter |
角标 |
2.21.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.21.1.3. 消耗
-
application/json
2.21.1.4. 生成
-
application/json;charset=utf-8
2.21.1.5. HTTP请求示例
请求 path
/v2/string/service/badge/query
请求 body
{
"codeIn" : [ "string" ],
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"purposeEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.21.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"purpose" : "string",
"template" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.21.2. get
GET /v2/{tenant}/service/badge/{orgType}/{orgId}/{id}
2.21.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
指定id |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
租户id |
string |
2.21.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.21.2.3. 生成
-
application/json;charset=utf-8
2.21.2.4. HTTP请求示例
请求 path
/v2/string/service/badge/string/string/string
2.21.2.5. HTTP响应示例
响应 200
{
"data" : {
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"purpose" : "string",
"template" : "string",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.22. 选项
Options Controller
2.22.1. 新建指定类型的选项
POST /v2/{tenant}/service/options/{type}/create
2.22.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Path |
type |
type |
string |
Query |
operator |
操作上下文 |
string |
Body |
creation |
新建选项 |
2.22.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.22.1.3. 消耗
-
application/json
2.22.1.4. 生成
-
application/json;charset=utf-8
2.22.1.5. HTTP请求示例
请求 path
/v2/string/service/options/string/create
请求 query
{
"operator" : "string"
}
请求 body
{
"key" : "string",
"parameters" : [ {
"name" : "string",
"value" : "string"
} ],
"value" : "string"
}
2.22.1.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.22.2. 查询指定的选项
POST /v2/{tenant}/service/options/{type}/query
2.22.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Path |
type |
type |
string |
Body |
filter |
查询条件 |
2.22.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.22.2.3. 消耗
-
application/json
2.22.2.4. 生成
-
application/json;charset=utf-8
2.22.2.5. HTTP请求示例
请求 path
/v2/string/service/options/string/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"enableEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyEq" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.22.2.6. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"key" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"parameters" : [ {
"name" : "string",
"value" : "string"
} ],
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"value" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.22.3. 禁用指定ID
POST /v2/{tenant}/service/options/{type}/{id}/disable
2.22.3.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
Path |
type |
type |
string |
Query |
operator |
操作上下文 |
string |
2.22.3.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.22.3.3. 消耗
-
application/json
2.22.3.4. 生成
-
application/json;charset=utf-8
2.22.3.5. HTTP请求示例
请求 path
/v2/string/service/options/string/string/disable
请求 query
{
"operator" : "string"
}
2.22.3.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.22.4. 启用指定ID
POST /v2/{tenant}/service/options/{type}/{id}/enable
2.22.4.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
Path |
type |
type |
string |
Query |
operator |
操作上下文 |
string |
2.22.4.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.22.4.3. 消耗
-
application/json
2.22.4.4. 生成
-
application/json;charset=utf-8
2.22.4.5. HTTP请求示例
请求 path
/v2/string/service/options/string/string/enable
请求 query
{
"operator" : "string"
}
2.22.4.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.22.5. 更新指定类型的选项
POST /v2/{tenant}/service/options/{type}/{id}/update
2.22.5.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
Path |
type |
type |
string |
Query |
operator |
操作上下文 |
string |
Body |
update |
更新选项 |
2.22.5.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.22.5.3. 消耗
-
application/json
2.22.5.4. 生成
-
application/json;charset=utf-8
2.22.5.5. HTTP请求示例
请求 path
/v2/string/service/options/string/string/update
请求 query
{
"operator" : "string"
}
请求 body
{
"key" : "string",
"parameters" : [ {
"name" : "string",
"value" : "string"
} ],
"value" : "string"
}
2.22.5.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.23. 配送方式&配送费配置
Delivery Controller
2.23.1. 查询配送
POST /v2/{tenant}/service/delivery/freight/query
2.23.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
filter |
2.23.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.23.1.3. 消耗
-
application/json
2.23.1.4. 生成
-
application/json;charset=utf-8
2.23.1.5. HTTP请求示例
请求 path
/v2/string/service/delivery/freight/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"modifiedGt" : "string",
"modifiedLt" : "string",
"orgIdEq" : "string",
"orgIdIn" : [ "string" ],
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.23.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"deliveryFee" : 0.0,
"freeSelfTake" : true,
"id" : "string",
"incrByWeight" : true,
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"orgId" : "string",
"orgType" : "string",
"packFee" : 0.0,
"platformId" : "string",
"regions" : [ {
"points" : [ {
"latitude" : "string",
"longitude" : "string",
"order" : 0
} ],
"radius" : 0.0,
"type" : "string"
} ],
"startFee" : 0.0,
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string",
"weightFeeRule" : {
"base" : 0.0,
"offset" : 0.0,
"offsetFee" : 0.0
}
} ],
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.23.2. 查询配送方式
POST /v2/{tenant}/service/delivery/query
2.23.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
filter |
2.23.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.23.2.3. 消耗
-
application/json
2.23.2.4. 生成
-
application/json;charset=utf-8
2.23.2.5. HTTP请求示例
请求 path
/v2/string/service/delivery/query
请求 body
{
"bizKeyEq" : "string",
"bizKeyIn" : [ "string" ],
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"modifiedGt" : "string",
"modifiedLt" : "string",
"orgIdEq" : "string",
"orgTypeEq" : "string",
"page" : 0,
"pageSize" : 0,
"platformIdEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"typeEq" : "string",
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.23.2.6. HTTP响应示例
响应 200
{
"data" : [ {
"bizKey" : "string",
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"platformId" : "string",
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.23.3. 获取组织配送费配置
GET /v2/{tenant}/service/delivery/{orgType}/{orgId}/freight
2.23.3.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
tenant |
string |
2.23.3.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.23.3.3. 生成
-
application/json;charset=utf-8
2.23.3.4. HTTP请求示例
请求 path
/v2/string/service/delivery/string/string/freight
2.23.3.5. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"deliveryFee" : 0.0,
"freeSelfTake" : true,
"id" : "string",
"incrByWeight" : true,
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"orgId" : "string",
"orgType" : "string",
"packFee" : 0.0,
"platformId" : "string",
"regions" : [ {
"points" : [ {
"latitude" : "string",
"longitude" : "string",
"order" : 0
} ],
"radius" : 0.0,
"type" : "string"
} ],
"startFee" : 0.0,
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string",
"weightFeeRule" : {
"base" : 0.0,
"offset" : 0.0,
"offsetFee" : 0.0
}
} ],
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.23.4. 获取组织配送方式
GET /v2/{tenant}/service/delivery/{orgType}/{orgId}/{type}/{bizKey}/deliveries
2.23.4.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
bizKey |
bizKey |
string |
Path |
orgId |
orgId |
string |
Path |
orgType |
orgType |
string |
Path |
tenant |
tenant |
string |
Path |
type |
type |
string |
2.23.4.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.23.4.3. 生成
-
application/json;charset=utf-8
2.23.4.4. HTTP请求示例
请求 path
/v2/string/service/delivery/string/string/string/string/deliveries
2.23.4.5. HTTP响应示例
响应 200
{
"data" : [ {
"bizKey" : "string",
"code" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"platformId" : "string",
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.24. 门店
Shop Controller
2.24.1. 创建门店
POST /v2/{tenant}/service/shop/create
2.24.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Query |
operator |
操作上下文 |
string |
Body |
shop |
门店信息 |
2.24.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.24.1.3. 消耗
-
application/json
2.24.1.4. 生成
-
application/json;charset=utf-8
2.24.1.5. HTTP请求示例
请求 path
/v2/string/service/shop/create
请求 query
{
"operator" : "string"
}
请求 body
{
"address" : {
"cityId" : "string",
"cityName" : "string",
"country" : "string",
"detailAddress" : "string",
"districtId" : "string",
"districtName" : "string",
"latitude" : "string",
"longitude" : "string",
"postcode" : "string",
"provinceId" : "string",
"provinceName" : "string",
"streetId" : "string",
"streetName" : "string"
},
"businessCircles" : [ "string" ],
"businessHour" : "string",
"code" : "string",
"complainPhoneHour" : "string",
"complainPhoneNumber" : "string",
"configs" : {
"string" : "string"
},
"contact" : {
"email" : "string",
"fax" : "string",
"mobile" : "string",
"name" : "string",
"telephone" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"facadeImage" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"level" : "string",
"name" : "string",
"remaindPhoneNumber" : "string",
"servicePhoneNumber" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
}
2.24.1.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.24.2. 查询门店分页列表
POST /v2/{tenant}/service/shop/query
2.24.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.24.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.24.2.3. 消耗
-
application/json
2.24.2.4. 生成
-
application/json;charset=utf-8
2.24.2.5. HTTP请求示例
请求 path
/v2/string/service/shop/query
请求 body
{
"addressLike" : "string",
"businessCircleEq" : "string",
"cityEq" : "string",
"cityIn" : [ "string" ],
"codeEq" : "string",
"codeIn" : [ "string" ],
"codeLike" : "string",
"codeNotIn" : [ "string" ],
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"enabledEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"levelEq" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"nameLike" : "string",
"page" : 0,
"pageSize" : 0,
"platformEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"typeEq" : "string",
"typeIn" : [ "string" ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.24.2.6. HTTP响应示例
响应 200
{
"data" : [ {
"address" : {
"cityId" : "string",
"cityName" : "string",
"country" : "string",
"detailAddress" : "string",
"districtId" : "string",
"districtName" : "string",
"latitude" : "string",
"longitude" : "string",
"postcode" : "string",
"provinceId" : "string",
"provinceName" : "string",
"streetId" : "string",
"streetName" : "string"
},
"businessCircles" : [ "string" ],
"businessHour" : "string",
"code" : "string",
"complainPhoneHour" : "string",
"complainPhoneNumber" : "string",
"configs" : {
"string" : "string"
},
"contact" : {
"email" : "string",
"fax" : "string",
"mobile" : "string",
"name" : "string",
"telephone" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"facadeImage" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"level" : "string",
"name" : "string",
"remaindPhoneNumber" : "string",
"servicePhoneNumber" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.24.3. 禁用门店
POST /v2/{tenant}/service/shop/{id}/disable
2.24.3.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
Query |
operator |
操作人 |
string |
2.24.3.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.24.3.3. 消耗
-
application/json
2.24.3.4. 生成
-
application/json;charset=utf-8
2.24.3.5. HTTP请求示例
请求 path
/v2/string/service/shop/string/disable
请求 query
{
"operator" : "string"
}
2.24.3.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.24.4. 启用门店
POST /v2/{tenant}/service/shop/{id}/enable
2.24.4.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
Query |
operator |
操作人 |
string |
2.24.4.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.24.4.3. 消耗
-
application/json
2.24.4.4. 生成
-
application/json;charset=utf-8
2.24.4.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.24.5. 获取指定门店
GET /v2/{tenant}/service/shop/{id}/get
2.24.5.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
2.24.5.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.24.5.3. 生成
-
application/json;charset=utf-8
2.24.5.4. HTTP请求示例
请求 path
/v2/string/service/shop/string/get
2.24.5.5. HTTP响应示例
响应 200
{
"data" : {
"address" : {
"cityId" : "string",
"cityName" : "string",
"country" : "string",
"detailAddress" : "string",
"districtId" : "string",
"districtName" : "string",
"latitude" : "string",
"longitude" : "string",
"postcode" : "string",
"provinceId" : "string",
"provinceName" : "string",
"streetId" : "string",
"streetName" : "string"
},
"businessCircles" : [ "string" ],
"businessHour" : "string",
"code" : "string",
"complainPhoneHour" : "string",
"complainPhoneNumber" : "string",
"configs" : {
"string" : "string"
},
"contact" : {
"email" : "string",
"fax" : "string",
"mobile" : "string",
"name" : "string",
"telephone" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"facadeImage" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"level" : "string",
"name" : "string",
"remaindPhoneNumber" : "string",
"servicePhoneNumber" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.24.6. 更新门店信息
POST /v2/{tenant}/service/shop/{id}/update
2.24.6.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
Query |
operator |
操作上下文 |
string |
Body |
shop |
门店 |
2.24.6.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.24.6.3. 消耗
-
application/json
2.24.6.4. 生成
-
application/json;charset=utf-8
2.24.6.5. HTTP请求示例
请求 path
/v2/string/service/shop/string/update
请求 query
{
"operator" : "string"
}
请求 body
{
"address" : {
"cityId" : "string",
"cityName" : "string",
"country" : "string",
"detailAddress" : "string",
"districtId" : "string",
"districtName" : "string",
"latitude" : "string",
"longitude" : "string",
"postcode" : "string",
"provinceId" : "string",
"provinceName" : "string",
"streetId" : "string",
"streetName" : "string"
},
"businessCircles" : [ "string" ],
"businessHour" : "string",
"code" : "string",
"complainPhoneHour" : "string",
"complainPhoneNumber" : "string",
"configs" : {
"string" : "string"
},
"contact" : {
"email" : "string",
"fax" : "string",
"mobile" : "string",
"name" : "string",
"telephone" : "string"
},
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"facadeImage" : "string",
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"level" : "string",
"name" : "string",
"remaindPhoneNumber" : "string",
"servicePhoneNumber" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"tenant" : "string",
"type" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
}
2.24.6.6. HTTP响应示例
响应 200
{
"data" : "object",
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.25. 门店商品
Shop Sku Controller
2.25.1. 查询门店商品列表
POST /v2/{tenant}/service/shopSku/query
2.25.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
查询条件 |
2.25.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.25.1.3. 消耗
-
application/json
2.25.1.4. 生成
-
application/json;charset=utf-8
2.25.1.5. HTTP请求示例
请求 path
/v2/string/service/shopSku/query
请求 body
{
"createdGt" : "string",
"createdLt" : "string",
"deletedEq" : true,
"fetchParts" : "string",
"idEq" : "string",
"idIn" : [ "string" ],
"keyword" : "string",
"modifiedGt" : "string",
"modifiedLt" : "string",
"page" : 0,
"pageSize" : 0,
"shopIdEq" : "string",
"skuBusinessTypeEq" : "string",
"skuIdEq" : "string",
"skuIdIn" : [ "string" ],
"skuInputCodeCodeEq" : "string",
"skuInputCodeCodeIn" : [ "string" ],
"skuSaleTypeEq" : "string",
"skuTypeEq" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ],
"uuidEq" : "string",
"uuidIn" : [ "string" ]
}
2.25.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"saleStatus" : true,
"shop" : {
"id" : "string",
"name" : "string"
},
"sku" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
},
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.25.2. 获取指定门店商品
GET /v2/{tenant}/service/shopSku/{id}
2.25.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
2.25.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.25.2.3. 生成
-
application/json;charset=utf-8
2.25.2.4. HTTP请求示例
请求 path
/v2/string/service/shopSku/string
2.25.2.5. HTTP响应示例
响应 200
{
"data" : {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"enabled" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"saleStatus" : true,
"shop" : {
"id" : "string",
"name" : "string"
},
"sku" : {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ {
"attributes" : [ {
"name" : "string",
"options" : [ "string" ]
} ],
"brand" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"businessType" : "string",
"category" : {
"code" : "string",
"id" : "string",
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"path" : "string",
"upper" : "string"
},
"code" : "string",
"comboType" : "string",
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"customFields" : [ {
"name" : "string",
"value" : "string"
} ],
"deleted" : true,
"description" : "string",
"descriptions" : [ {
"content" : "string",
"order" : 0,
"type" : "string"
} ],
"enabled" : true,
"endSellDate" : "string",
"firstSaleTime" : "string",
"goodsId" : "string",
"height" : 0.0,
"id" : "string",
"image" : "string",
"images" : [ "string" ],
"inputCode" : {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
},
"inputCodes" : [ {
"code" : "string",
"qpc" : 0.0,
"qpcStr" : "string",
"type" : "string",
"unit" : "string",
"weight" : 0.0
} ],
"items" : [ "..." ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
} ],
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"length" : 0.0,
"marketPrice" : 0.0,
"name" : "string",
"orgId" : "string",
"orgType" : "string",
"properties" : [ {
"name" : "string",
"value" : "string"
} ],
"purchasePrice" : 0.0,
"qpc" : 0.0,
"qpcStr" : "string",
"qualified" : true,
"quantity" : 0.0,
"saleStatus" : true,
"saleType" : "string",
"spec" : "string",
"specFloatingSpace" : 0.0,
"startSellDate" : "string",
"subTitle" : "string",
"tags" : [ {
"color" : "string",
"name" : "string"
} ],
"taxRate" : "string",
"taxSortCode" : "string",
"tenant" : "string",
"title" : "string",
"type" : "string",
"unit" : "string",
"uuid" : "string",
"valuationType" : "string",
"version" : 0,
"versionTime" : "string",
"video" : "string",
"weight" : 0.0,
"width" : 0.0
},
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
},
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.26. 门店商品价格
Shop Sku Price Controller
2.26.1. create
POST /v2/{tenant}/service/shopskuprice/create
2.26.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
prices |
商品价格集合 |
2.26.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.26.1.3. 消耗
-
application/json
2.26.1.4. 生成
-
application/json;charset=utf-8
2.26.1.5. HTTP请求示例
请求 path
/v2/string/service/shopskuprice/create
请求 query
{
"operator" : "string"
}
请求 body
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"mbrPrice" : 15.25,
"price" : 12.25,
"shopId" : "0001",
"skuId" : "54654",
"tenant" : "string",
"unitPrice" : 12.35,
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ]
}
2.26.1.6. HTTP响应示例
响应 200
{
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.26.2. query
POST /v2/{tenant}/service/shopskuprice/query
2.26.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户ID |
string |
Body |
filter |
查询条件 |
2.26.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.26.2.3. 消耗
-
application/json
2.26.2.4. 生成
-
application/json;charset=utf-8
2.26.2.5. HTTP请求示例
请求 path
/v2/string/service/shopskuprice/query
请求 body
{
"fetchParts" : "string",
"page" : 0,
"pageSize" : 0,
"shopIdIn" : [ "string" ],
"skuIdIn" : [ "string" ],
"skuIdLike" : "string",
"skuIdStartWith" : "string",
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ]
}
2.26.2.6. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"mbrPrice" : 15.25,
"price" : 12.25,
"shopId" : "0001",
"skuId" : "54654",
"tenant" : "string",
"unitPrice" : 12.35,
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.26.3. update
POST /v2/{tenant}/service/shopskuprice/update
2.26.3.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
prices |
商品价格集合 |
2.26.3.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.26.3.3. 消耗
-
application/json
2.26.3.4. 生成
-
application/json;charset=utf-8
2.26.3.5. HTTP请求示例
请求 path
/v2/string/service/shopskuprice/update
请求 query
{
"operator" : "string"
}
请求 body
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"mbrPrice" : 15.25,
"price" : 12.25,
"shopId" : "0001",
"skuId" : "54654",
"tenant" : "string",
"unitPrice" : 12.35,
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ]
}
2.26.3.6. HTTP响应示例
响应 200
{
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.27. 门店商品库存
Shop Sku Inv Controller
2.27.1. 查询门店商品库存
POST /v2/{tenant}/service/shopskuinv/query
2.27.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户ID |
string |
Body |
filter |
商品库存查询条件 |
2.27.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.27.1.3. 消耗
-
application/json
2.27.1.4. 生成
-
application/json;charset=utf-8
2.27.1.5. HTTP请求示例
请求 path
/v2/string/service/shopskuinv/query
请求 body
{
"fetchParts" : "string",
"page" : 0,
"pageSize" : 0,
"shopIdIn" : [ "string" ],
"skuIdIn" : [ "string" ],
"sorts" : [ {
"desc" : true,
"sortKey" : "string"
} ]
}
2.27.1.6. HTTP响应示例
响应 200
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"qty" : 155.0,
"shopId" : "0001",
"skuId" : "1111",
"source" : "ERP",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ],
"echoCode" : 0,
"echoMessage" : "string",
"page" : 0,
"pageCount" : 0,
"pageSize" : 0,
"success" : true,
"total" : 0
}
2.27.2. 保存门店商品库存
POST /v2/{tenant}/service/shopskuinv/save
2.27.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
data |
商品库存集合 |
2.27.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.27.2.3. 消耗
-
application/json
2.27.2.4. 生成
-
application/json;charset=utf-8
2.27.2.5. HTTP请求示例
请求 path
/v2/string/service/shopskuinv/save
请求 query
{
"operator" : "string"
}
请求 body
{
"data" : [ {
"createInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"deleted" : true,
"id" : "string",
"lastModifyInfo" : {
"operator" : {
"fullName" : "string",
"id" : "string",
"namespace" : "string",
"qualifiedId" : "string"
},
"time" : "string"
},
"qty" : 155.0,
"shopId" : "0001",
"skuId" : "1111",
"source" : "ERP",
"tenant" : "string",
"uuid" : "string",
"version" : 0,
"versionTime" : "string"
} ]
}
2.27.2.6. HTTP响应示例
响应 200
{
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.28. 第三方平台更新中台商品图片
image sku update Controller
2.28.1. 更新中台商品图片
POST /v2/{tenant}/service/image/sku/update
2.28.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
租户ID |
string |
Query |
operate |
操作人 |
string |
Body |
sku_images |
商品图片列表,每次更新不超过30条 |
2.28.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.28.1.3. 消耗
-
application/json
2.28.1.4. 生成
-
application/json;charset=utf-8
2.28.1.5. HTTP请求示例
请求 path
/v2/string/service/image/sku/update
请求 body
{
"sku_images" : [ {
"sku_id" : "string",
"image" : {
"url" : "http://aa.png",
"sort" : 1
},
"sub_images" : [ {
"url" : "http://aa.png",
"sort" : 1
} ],
"detail_images" : [ {
"url" : "http://aa.png",
"sort" : 1
} ]
} ]
}
2.28.1.6. HTTP响应示例
响应 200
{
"echoCode" : 0,
"echoMessage" : "string",
"success" : true
}
2.29. 平台前台Spu 服务
PlatformFrontSpu Controller
2.29.1. 查询PlatformFrontSpu列表
POST /v2/{tenant}/service/platformfrontspu
2.29.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
query filter |
2.29.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.29.1.3. 消耗
-
application/json
2.29.1.4. 生成
-
application/json;charset=utf-8
2.29.1.5. HTTP请求示例
请求 path
/v2/string/service/platformfrontspu/query
请求 body
{
"createdGt": "2021-02-25T07:41:53.499Z",
"createdLt": "2021-02-25T07:41:53.499Z",
"deletedEq": true,
"fetchParts": "string",
"frontSkuIdEq": "string",
"frontSkuIdIn": [
"string"
],
"idEq": "string",
"idIn": [
"string"
],
"modifiedGt": "2021-02-25T07:41:53.499Z",
"modifiedLt": "2021-02-25T07:41:53.499Z",
"page": 0,
"pageSize": 0,
"platformIdEq": "string",
"sorts": [
{
"desc": true,
"sortKey": "string"
}
],
"uuidEq": "string",
"uuidIn": [
"string"
]
}
2.29.1.6. HTTP响应示例
响应 200
{
"data": [
{
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"deleted": true,
"description": "string",
"id": "string",
"image": "string",
"images": [
"string"
],
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"name": "string",
"platform": {
"id": "string",
"name": "string"
},
"properties": [
{
"name": "string",
"values": [
"string"
]
}
],
"skus": [
{
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"deleted": true,
"frontSku": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"deleted": true,
"frontSpuId": "string",
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"properties": [
{
"name": "string",
"value": "string"
}
],
"sku": {
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"brand": {
"code": "string",
"id": "string",
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"businessType": "string",
"category": {
"code": "string",
"id": "string",
"level": 0,
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"code": "string",
"comboType": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"defaultSpecification": true,
"deleted": true,
"description": "string",
"descriptions": [
{
"content": "string",
"order": 0,
"type": "string"
}
],
"enabled": true,
"endSellDate": "2021-03-15T02:37:51.778Z",
"firstSaleTime": "2021-03-15T02:37:51.778Z",
"foodSuggestion": "string",
"goodsId": "string",
"height": 0,
"id": "string",
"image": "string",
"images": [
"string"
],
"inputCode": {
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
},
"inputCodes": [
{
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
}
],
"isDiffCombo": true,
"isVirtual": true,
"items": [
null
],
"labelPrinting": true,
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"length": 0,
"marketPrice": 0,
"mbrPrice": 0,
"minOrderQty": 0,
"multiSpecification": true,
"name": "string",
"orgId": "string",
"orgType": "string",
"packingName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"purchasePrice": 0,
"qpc": 0,
"qpcStr": "string",
"qualified": true,
"quantity": 0,
"saleStatus": true,
"saleType": "string",
"showIndex": 0,
"spec": "string",
"specFloatingSpace": 0,
"spuId": "string",
"startSellDate": "2021-03-15T02:37:51.778Z",
"subTitle": "string",
"tags": [
{
"color": "string",
"lineNo": 0,
"name": "string"
}
],
"tasteGroups": [
{
"showIndex": 0,
"tasteGroup": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"deleted": true,
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"name": "string",
"showIndex": 0,
"tastes": [
{
"id": "string",
"name": "string",
"showIndex": 0
}
],
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:37:51.778Z"
}
}
],
"taxRate": "string",
"taxSortCode": "string",
"tenant": "string",
"title": "string",
"traceId": "string",
"type": "string",
"unit": "string",
"upc": "string",
"uuid": "string",
"valuationType": "string",
"version": 0,
"versionTime": "2021-03-15T02:37:51.778Z",
"video": "string",
"weight": 0,
"width": 0
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:37:51.778Z"
},
"frontSkuId": "string",
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"platformCategories": [
{
"id": "string",
"name": "string"
}
],
"platformId": "string",
"sku": {
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"brand": {
"code": "string",
"id": "string",
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"businessType": "string",
"category": {
"code": "string",
"id": "string",
"level": 0,
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"code": "string",
"comboType": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"defaultSpecification": true,
"deleted": true,
"description": "string",
"descriptions": [
{
"content": "string",
"order": 0,
"type": "string"
}
],
"enabled": true,
"endSellDate": "2021-03-15T02:37:51.778Z",
"firstSaleTime": "2021-03-15T02:37:51.778Z",
"foodSuggestion": "string",
"goodsId": "string",
"height": 0,
"id": "string",
"image": "string",
"images": [
"string"
],
"inputCode": {
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
},
"inputCodes": [
{
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
}
],
"isDiffCombo": true,
"isVirtual": true,
"items": [
null
],
"labelPrinting": true,
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.778Z"
},
"length": 0,
"marketPrice": 0,
"mbrPrice": 0,
"minOrderQty": 0,
"multiSpecification": true,
"name": "string",
"orgId": "string",
"orgType": "string",
"packingName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"purchasePrice": 0,
"qpc": 0,
"qpcStr": "string",
"qualified": true,
"quantity": 0,
"saleStatus": true,
"saleType": "string",
"showIndex": 0,
"spec": "string",
"specFloatingSpace": 0,
"spuId": "string",
"startSellDate": "2021-03-15T02:37:51.779Z",
"subTitle": "string",
"tags": [
{
"color": "string",
"lineNo": 0,
"name": "string"
}
],
"tasteGroups": [
{
"showIndex": 0,
"tasteGroup": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.779Z"
},
"deleted": true,
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:37:51.779Z"
},
"name": "string",
"showIndex": 0,
"tastes": [
{
"id": "string",
"name": "string",
"showIndex": 0
}
],
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:37:51.779Z"
}
}
],
"taxRate": "string",
"taxSortCode": "string",
"tenant": "string",
"title": "string",
"traceId": "string",
"type": "string",
"unit": "string",
"upc": "string",
"uuid": "string",
"valuationType": "string",
"version": 0,
"versionTime": "2021-03-15T02:37:51.779Z",
"video": "string",
"weight": 0,
"width": 0
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:37:51.779Z"
}
],
"tenant": "string",
"traceId": "string",
"type": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:37:51.779Z"
}
],
"echoCode": 0,
"echoMessage": "string",
"page": 0,
"pageCount": 0,
"pageSize": 0,
"success": true,
"total": 0
}
2.29.2. 获取指定PlatformFrontSpu信息
GET /v2/{tenant}/service/platformfrontspu/{platformId}/{frontSpuId}/
2.29.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
platformId |
id |
string |
Path |
frontSpuId |
tenant |
string |
2.29.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.29.2.3. 生成
-
application/json;charset=utf-8
2.29.2.4. HTTP请求示例
请求 path
/v2/string/service/platformfrontspu/string/string
2.29.2.5. HTTP响应示例
响应 200
{
"data": {
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"deleted": true,
"description": "string",
"id": "string",
"image": "string",
"images": [
"string"
],
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"name": "string",
"platform": {
"id": "string",
"name": "string"
},
"properties": [
{
"name": "string",
"values": [
"string"
]
}
],
"skus": [
{
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"deleted": true,
"frontSku": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"deleted": true,
"frontSpuId": "string",
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"properties": [
{
"name": "string",
"value": "string"
}
],
"sku": {
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"brand": {
"code": "string",
"id": "string",
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"businessType": "string",
"category": {
"code": "string",
"id": "string",
"level": 0,
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"code": "string",
"comboType": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"defaultSpecification": true,
"deleted": true,
"description": "string",
"descriptions": [
{
"content": "string",
"order": 0,
"type": "string"
}
],
"enabled": true,
"endSellDate": "2021-03-15T02:36:42.206Z",
"firstSaleTime": "2021-03-15T02:36:42.206Z",
"foodSuggestion": "string",
"goodsId": "string",
"height": 0,
"id": "string",
"image": "string",
"images": [
"string"
],
"inputCode": {
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
},
"inputCodes": [
{
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
}
],
"isDiffCombo": true,
"isVirtual": true,
"items": [
null
],
"labelPrinting": true,
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"length": 0,
"marketPrice": 0,
"mbrPrice": 0,
"minOrderQty": 0,
"multiSpecification": true,
"name": "string",
"orgId": "string",
"orgType": "string",
"packingName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"purchasePrice": 0,
"qpc": 0,
"qpcStr": "string",
"qualified": true,
"quantity": 0,
"saleStatus": true,
"saleType": "string",
"showIndex": 0,
"spec": "string",
"specFloatingSpace": 0,
"spuId": "string",
"startSellDate": "2021-03-15T02:36:42.206Z",
"subTitle": "string",
"tags": [
{
"color": "string",
"lineNo": 0,
"name": "string"
}
],
"tasteGroups": [
{
"showIndex": 0,
"tasteGroup": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"deleted": true,
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"name": "string",
"showIndex": 0,
"tastes": [
{
"id": "string",
"name": "string",
"showIndex": 0
}
],
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:36:42.206Z"
}
}
],
"taxRate": "string",
"taxSortCode": "string",
"tenant": "string",
"title": "string",
"traceId": "string",
"type": "string",
"unit": "string",
"upc": "string",
"uuid": "string",
"valuationType": "string",
"version": 0,
"versionTime": "2021-03-15T02:36:42.206Z",
"video": "string",
"weight": 0,
"width": 0
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:36:42.206Z"
},
"frontSkuId": "string",
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"platformCategories": [
{
"id": "string",
"name": "string"
}
],
"platformId": "string",
"sku": {
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"brand": {
"code": "string",
"id": "string",
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"businessType": "string",
"category": {
"code": "string",
"id": "string",
"level": 0,
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"code": "string",
"comboType": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"defaultSpecification": true,
"deleted": true,
"description": "string",
"descriptions": [
{
"content": "string",
"order": 0,
"type": "string"
}
],
"enabled": true,
"endSellDate": "2021-03-15T02:36:42.206Z",
"firstSaleTime": "2021-03-15T02:36:42.206Z",
"foodSuggestion": "string",
"goodsId": "string",
"height": 0,
"id": "string",
"image": "string",
"images": [
"string"
],
"inputCode": {
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
},
"inputCodes": [
{
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
}
],
"isDiffCombo": true,
"isVirtual": true,
"items": [
null
],
"labelPrinting": true,
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"length": 0,
"marketPrice": 0,
"mbrPrice": 0,
"minOrderQty": 0,
"multiSpecification": true,
"name": "string",
"orgId": "string",
"orgType": "string",
"packingName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"purchasePrice": 0,
"qpc": 0,
"qpcStr": "string",
"qualified": true,
"quantity": 0,
"saleStatus": true,
"saleType": "string",
"showIndex": 0,
"spec": "string",
"specFloatingSpace": 0,
"spuId": "string",
"startSellDate": "2021-03-15T02:36:42.206Z",
"subTitle": "string",
"tags": [
{
"color": "string",
"lineNo": 0,
"name": "string"
}
],
"tasteGroups": [
{
"showIndex": 0,
"tasteGroup": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"deleted": true,
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-03-15T02:36:42.206Z"
},
"name": "string",
"showIndex": 0,
"tastes": [
{
"id": "string",
"name": "string",
"showIndex": 0
}
],
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:36:42.206Z"
}
}
],
"taxRate": "string",
"taxSortCode": "string",
"tenant": "string",
"title": "string",
"traceId": "string",
"type": "string",
"unit": "string",
"upc": "string",
"uuid": "string",
"valuationType": "string",
"version": 0,
"versionTime": "2021-03-15T02:36:42.206Z",
"video": "string",
"weight": 0,
"width": 0
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:36:42.206Z"
}
],
"tenant": "string",
"traceId": "string",
"type": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-03-15T02:36:42.206Z"
},
"echoCode": 0,
"echoMessage": "string",
"success": true
}
2.30. 平台门店前台sku服务
PlatformShopFrontSku Controller
2.30.1. 查询platformshopfrontsku列表
POST /v2/{tenant}/service/platformshopfrontsku
2.30.1.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant |
tenant |
string |
Body |
filter |
query filter |
2.30.1.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
201 |
Created |
无内容 |
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.30.1.3. 消耗
-
application/json
2.30.1.4. 生成
-
application/json;charset=utf-8
2.30.1.5. HTTP请求示例
请求 path
/v2/string/service/platformshopfrontsku/query
请求 body
{
"createdGt": "2021-02-26T09:29:31.880Z",
"createdLt": "2021-02-26T09:29:31.880Z",
"deletedEq": true,
"fetchParts": "string",
"frontSkuIdEq": "string",
"frontSkuIdIn": [
"string"
],
"hasPlatformSkuId": true,
"idEq": "string",
"idIn": [
"string"
],
"modifiedGt": "2021-02-26T09:29:31.880Z",
"modifiedLt": "2021-02-26T09:29:31.880Z",
"page": 0,
"pageSize": 0,
"platformIdEq": "string",
"platformIdIn": [
"string"
],
"platformSkuIdIn": [
"string"
],
"shopIdEq": "string",
"shopIdIn": [
"string"
],
"sorts": [
{
"desc": true,
"sortKey": "string"
}
],
"uuidEq": "string",
"uuidIn": [
"string"
]
}
2.30.1.6. HTTP响应示例
响应 200
{
"data": [
{
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"deleted": true,
"enabled": true,
"frontSku": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"deleted": true,
"frontSpuId": "string",
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"properties": [
{
"name": "string",
"value": "string"
}
],
"sku": {
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"brand": {
"code": "string",
"id": "string",
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"businessType": "string",
"category": {
"code": "string",
"id": "string",
"level": 0,
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"code": "string",
"comboType": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"defaultSpecification": true,
"deleted": true,
"description": "string",
"descriptions": [
{
"content": "string",
"order": 0,
"type": "string"
}
],
"enabled": true,
"endSellDate": "2021-02-26T09:29:31.921Z",
"firstSaleTime": "2021-02-26T09:29:31.921Z",
"foodSuggestion": "string",
"goodsId": "string",
"height": 0,
"id": "string",
"image": "string",
"images": [
"string"
],
"inputCode": {
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
},
"inputCodes": [
{
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
}
],
"isDiffCombo": true,
"isVirtual": true,
"items": [
null
],
"labelPrinting": true,
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"length": 0,
"marketPrice": 0,
"mbrPrice": 0,
"minOrderQty": 0,
"multiSpecification": true,
"name": "string",
"orgId": "string",
"orgType": "string",
"packingName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"purchasePrice": 0,
"qpc": 0,
"qpcStr": "string",
"qualified": true,
"quantity": 0,
"saleStatus": true,
"saleType": "string",
"showIndex": 0,
"spec": "string",
"specFloatingSpace": 0,
"spuId": "string",
"startSellDate": "2021-02-26T09:29:31.921Z",
"subTitle": "string",
"tags": [
{
"color": "string",
"lineNo": 0,
"name": "string"
}
],
"tasteGroups": [
{
"showIndex": 0,
"tasteGroup": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"deleted": true,
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"name": "string",
"showIndex": 0,
"tastes": [
{
"id": "string",
"name": "string",
"showIndex": 0
}
],
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-02-26T09:29:31.921Z"
}
}
],
"taxRate": "string",
"taxSortCode": "string",
"tenant": "string",
"title": "string",
"traceId": "string",
"type": "string",
"unit": "string",
"upc": "string",
"uuid": "string",
"valuationType": "string",
"version": 0,
"versionTime": "2021-02-26T09:29:31.921Z",
"video": "string",
"weight": 0,
"width": 0
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-02-26T09:29:31.921Z"
},
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:29:31.921Z"
},
"platform": {
"id": "string",
"name": "string"
},
"shop": {
"code": "string",
"id": "string",
"name": "string"
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-02-26T09:29:31.921Z"
}
],
"echoCode": 0,
"echoMessage": "string",
"page": 0,
"pageCount": 0,
"pageSize": 0,
"success": true,
"total": 0
}
2.30.2. 获取指定PlatformShopFrontSku信息
GET /v2/{tenant}/service/platformshopfrontsku/{platformId}/
2.30.2.1. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Path |
tenant |
tenant |
string |
2.30.2.2. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
无内容 |
403 |
Forbidden |
无内容 |
404 |
Not Found |
无内容 |
2.30.2.3. 生成
-
application/json;charset=utf-8
2.30.2.4. HTTP请求示例
请求 path
/v2/string/service/platformshopfrontsku/string
2.30.2.5. HTTP响应示例
响应 200
{
"data": {
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"deleted": true,
"enabled": true,
"frontSku": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"deleted": true,
"frontSpuId": "string",
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"properties": [
{
"name": "string",
"value": "string"
}
],
"sku": {
"attributes": [
{
"name": "string",
"options": [
"string"
]
}
],
"brand": {
"code": "string",
"id": "string",
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"businessType": "string",
"category": {
"code": "string",
"id": "string",
"level": 0,
"name": "string",
"orgId": "string",
"orgType": "string",
"path": "string",
"upper": "string"
},
"code": "string",
"comboType": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"customFields": [
{
"name": "string",
"value": "string"
}
],
"defaultSpecification": true,
"deleted": true,
"description": "string",
"descriptions": [
{
"content": "string",
"order": 0,
"type": "string"
}
],
"enabled": true,
"endSellDate": "2021-02-26T09:34:03.584Z",
"firstSaleTime": "2021-02-26T09:34:03.584Z",
"foodSuggestion": "string",
"goodsId": "string",
"height": 0,
"id": "string",
"image": "string",
"images": [
"string"
],
"inputCode": {
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
},
"inputCodes": [
{
"code": "string",
"qpc": 0,
"qpcStr": "string",
"type": "string",
"unit": "string",
"weight": 0
}
],
"isDiffCombo": true,
"isVirtual": true,
"items": [
null
],
"labelPrinting": true,
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"length": 0,
"marketPrice": 0,
"mbrPrice": 0,
"minOrderQty": 0,
"multiSpecification": true,
"name": "string",
"orgId": "string",
"orgType": "string",
"packingName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"purchasePrice": 0,
"qpc": 0,
"qpcStr": "string",
"qualified": true,
"quantity": 0,
"saleStatus": true,
"saleType": "string",
"showIndex": 0,
"spec": "string",
"specFloatingSpace": 0,
"spuId": "string",
"startSellDate": "2021-02-26T09:34:03.584Z",
"subTitle": "string",
"tags": [
{
"color": "string",
"lineNo": 0,
"name": "string"
}
],
"tasteGroups": [
{
"showIndex": 0,
"tasteGroup": {
"code": "string",
"createInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"deleted": true,
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"name": "string",
"showIndex": 0,
"tastes": [
{
"id": "string",
"name": "string",
"showIndex": 0
}
],
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-02-26T09:34:03.584Z"
}
}
],
"taxRate": "string",
"taxSortCode": "string",
"tenant": "string",
"title": "string",
"traceId": "string",
"type": "string",
"unit": "string",
"upc": "string",
"uuid": "string",
"valuationType": "string",
"version": 0,
"versionTime": "2021-02-26T09:34:03.584Z",
"video": "string",
"weight": 0,
"width": 0
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-02-26T09:34:03.584Z"
},
"id": "string",
"lastModifyInfo": {
"operator": {
"fullName": "string",
"id": "string",
"namespace": "string",
"qualifiedId": "string"
},
"time": "2021-02-26T09:34:03.584Z"
},
"platform": {
"id": "string",
"name": "string"
},
"shop": {
"code": "string",
"id": "string",
"name": "string"
},
"tenant": "string",
"traceId": "string",
"uuid": "string",
"version": 0,
"versionTime": "2021-02-26T09:34:03.584Z"
},
"echoCode": 0,
"echoMessage": "string",
"success": true
}
3. 定义
3.1. AddressFilter
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
desc |
是否降序 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
levelEq |
层级等于,省份1,城市2,区域3,街道4 |
integer (int32) |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
nameEq |
名称等于 |
string |
orgTypeInclude |
组织类型包含于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sortKey |
排序字段 |
string |
sorts |
排序字段集合 |
< Sort > array |
upperEq |
上级地址等于 |
string |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.2. ApplicationAbout
名称 | 说明 | 类型 |
---|---|---|
build |
样例 : |
string |
commonTitle |
样例 : |
string |
copyright |
样例 : |
string |
groupId |
样例 : |
string |
localeTitle |
样例 : |
string |
site |
样例 : |
string |
title |
样例 : |
string |
version |
样例 : |
3.3. Condition
名称 | 说明 | 类型 |
---|---|---|
field |
字段名 |
string |
operator |
操作符 |
enum (equals, notQquals, in, notIn, rangeWithEqual, rangeWithNotEqual, startWidth, like, isNull, isNotNull) |
parameters |
条件值 |
< object > array |
3.4. HotWord
名称 | 说明 | 类型 |
---|---|---|
begin |
样例 : |
string (date-time) |
code |
样例 : |
string |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
end |
样例 : |
string (date-time) |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
orgId |
样例 : |
string |
orgType |
样例 : |
string |
places |
样例 : |
< string > array |
platformIds |
样例 : |
< string > array |
skuIds |
样例 : |
< string > array |
sort |
样例 : |
integer (int32) |
state |
样例 : |
enum (unpublished, online, offline, finished) |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
word |
样例 : |
string |
3.5. HotWordFilter
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
dateBeginGtEq |
开始日期大于等于 |
string (date-time) |
dateBeginLt |
开始日期小于 |
string (date-time) |
dateBeginLtEq |
开始日期小于等于 |
string (date-time) |
dateEndGtEq |
结束日期大于等于 |
string (date-time) |
dateEndLt |
结束日期小于 |
string (date-time) |
dateEndLtEq |
结束日期小于等于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyword |
名称,代码模糊 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
placeEq |
展示位 |
string |
platformIdEq |
平台 |
string |
sorts |
排序字段集合 |
< Sort > array |
stateEq |
状态 |
string |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.6. IdName
名称 | 说明 | 类型 |
---|---|---|
id |
样例 : |
string |
name |
样例 : |
string |
3.7. MasPageResponse«List«HotWord»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< HotWord > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.8. MasPageResponse«List«SKU»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< SKU > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.9. MasPageResponse«List«PlatformFrontSpu»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< PlatformFrontSpu > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.10. MasPageResponse«List«PlatformShopFrontSku»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< PlatformShopFrontSku > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.11. PlatformShopFrontSku
名称 | 说明 | 类型 |
---|---|---|
platform |
平台 |
|
shop |
门店 |
|
frontSku |
前台SKU |
|
enabled |
状态 |
boolean |
deleted |
已删除 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.12. IdCodeName
名称 | 说明 | 类型 |
---|---|---|
id |
样例 : |
string |
code |
样例 : |
string |
name |
样例 : |
string |
3.13. FrontSku
名称 | 说明 | 类型 |
---|---|---|
frontSpuId |
前台SPUID |
string |
code |
代码 |
string |
sku |
SKU |
|
properties |
商品销售属性 |
< 商品销售属性 > array |
deleted |
已删除 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
tmallBrandId |
天猫品牌id |
string |
tmallCategoryId |
天猫分类id |
string |
3.14. MasPageResponse«List«ShopSkuInv»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< ShopSkuInv > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.15. MasPageResponse«List«ShopSkuPrice»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< ShopSkuPrice > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.16. MasPageResponse«List«Spu»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< Spu > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.17. MasPageResponse«List«内容修饰»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 内容修饰 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.18. MasPageResponse«List«内容投放»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 内容投放 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.19. MasPageResponse«List«内容投放的位置»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 内容投放的位置 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.20. MasPageResponse«List«品牌»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 品牌 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.21. MasPageResponse«List«商品分类»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 商品分类 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.22. MasPageResponse«List«平台前台Sku»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 平台前台Sku > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.23. MasPageResponse«List«平台类目商品»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 平台类目商品 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.24. MasPageResponse«List«平台门店»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 平台门店 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.25. MasPageResponse«List«平台门店商品»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 平台门店商品 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.26. MasPageResponse«List«排序规则»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 排序规则 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.27. MasPageResponse«List«数据归档»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 数据归档 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.28. MasPageResponse«List«角标»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 角标 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.29. MasPageResponse«List«配送方式»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 配送方式 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.30. MasPageResponse«List«门店»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 门店 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.31. MasPageResponse«List«门店商品»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 门店商品 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.32. MasPageResponse«List«页面模板»»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< 页面模板 > array |
echoCode |
样例 : |
integer (int32) |
echoMessage |
样例 : |
string |
page |
样例 : |
integer (int32) |
pageCount |
样例 : |
integer (int32) |
pageSize |
样例 : |
integer (int32) |
success |
样例 : |
boolean |
total |
样例 : |
integer (int32) |
3.33. MasRequest«List«ShopSkuInv»»
名称 | 说明 | 类型 |
---|---|---|
data |
请求数据 |
< ShopSkuInv > array |
3.34. MasRequest«List«ShopSkuPrice»»
名称 | 说明 | 类型 |
---|---|---|
data |
请求数据 |
< ShopSkuPrice > array |
3.35. MasRequest«List«文档»»
名称 | 说明 | 类型 |
---|---|---|
data |
请求数据 |
< 文档 > array |
3.36. MasResponse
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
object |
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.37. MasResponse«List«地址库»»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
< 地址库 > array |
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.38. MasResponse«List«平台类目»»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
< 平台类目 > array |
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.39. MasResponse«List«平台门店类目»»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
< 平台门店类目 > array |
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.40. MasResponse«List«运费配置»»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
< 运费配置 > array |
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.41. MasResponse«List«选项»»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
< 选项 > array |
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.42. MasResponse«List«配送方式»»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
< 配送方式 > array |
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.43. MasResponse«SKU»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.44. MasResponse«PlatformFrontSpu»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.45. MasResponse«PlatformShopFrontSku»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.46. MasResponse«Spu»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.47. MasResponse«Void»
名称 | 说明 | 类型 |
---|---|---|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.48. MasResponse«内容修饰»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.49. MasResponse«内容投放»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.50. MasResponse«内容投放的位置»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.51. MasResponse«品牌»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.52. MasResponse«商品分类»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.53. MasResponse«平台前台Sku»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.54. MasResponse«平台门店»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.55. MasResponse«平台门店商品»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.56. MasResponse«文档»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.57. MasResponse«角标»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.58. MasResponse«门店»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.59. MasResponse«门店商品»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.60. MasResponse«页面模板»
名称 | 说明 | 类型 |
---|---|---|
data |
响应数据 |
|
echoCode |
响应吗 |
integer (int32) |
echoMessage |
响应信息 |
string |
success |
是否成功 |
boolean |
3.61. OperateInfo
名称 | 说明 | 类型 |
---|---|---|
operator |
样例 : |
|
time |
样例 : |
string (date-time) |
3.62. Operator
名称 | 说明 | 类型 |
---|---|---|
fullName |
样例 : |
string |
id |
样例 : |
string |
namespace |
样例 : |
string |
qualifiedId |
样例 : |
string |
3.63. OptionsCreation
名称 | 说明 | 类型 |
---|---|---|
key |
选项名 |
string |
parameters |
参数 |
< Parameter > array |
value |
选项值 |
string |
3.64. OptionsFilter
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
enableEq |
是否已启用等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyEq |
选项名等于 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.65. OptionsUpdate
名称 | 说明 | 类型 |
---|---|---|
key |
选项名 |
string |
parameters |
参数 |
< Parameter > array |
value |
选项值 |
string |
3.66. Parameter
名称 | 说明 | 类型 |
---|---|---|
name |
样例 : |
string |
value |
样例 : |
string |
3.67. PlatformFrontSkuFilter
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
frontSkuIdEq |
样例 : |
string |
frontSkuIdIn |
样例 : |
< string > array |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
platformIdEq |
样例 : |
string |
platformIdIn |
样例 : |
< string > array |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.68. Point
名称 | 说明 | 类型 |
---|---|---|
latitude |
样例 : |
string |
longitude |
样例 : |
string |
order |
样例 : |
integer (int32) |
3.69. RemoveDocRequest
名称 | 说明 | 类型 |
---|---|---|
docIds |
文档id列 |
< string > array |
index |
索引index |
string |
type |
索引type |
string |
3.70. SKU
名称 | 说明 | 类型 |
---|---|---|
attributes |
商品特性 |
< 商品特性 > array |
brand |
品牌 |
|
businessType |
经营方式, 经销,联营 |
string |
category |
分类 |
|
code |
代码 |
string |
comboType |
sku类型,普通/组合 |
string |
createInfo |
样例 : |
|
customFields |
自定义属性 |
< 商品参数 > array |
deleted |
已删除 |
boolean |
description |
描述 |
string |
descriptions |
图文详情 |
< 详情描述 > array |
enabled |
上下架状态 |
boolean |
endSellDate |
结束售卖时间 |
string (date-time) |
firstSaleTime |
首次售卖时间 |
string (date-time) |
goodsId |
goodsId |
string |
height |
高度 |
number |
id |
ID |
string |
image |
主图 |
string |
images |
副图 |
< string > array |
inputCode |
样例 : |
|
inputCodes |
输入码 |
< 输入码 > array |
items |
组合明细 |
< SKU > array |
lastModifyInfo |
样例 : |
|
length |
长度 |
number |
marketPrice |
参考市场价 |
number |
name |
名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
properties |
商品销售属性 |
< 商品销售属性 > array |
purchasePrice |
参考进价 |
number |
qpc |
规格 |
number |
qpcStr |
规格说明 |
string |
qualified |
是否合格, 可用于标记主图是否合格 |
boolean |
quantity |
样例 : |
number |
saleStatus |
是否可售卖 |
boolean |
saleType |
销售方式, 散装, 标准 |
string |
spec |
包装规格 |
string |
specFloatingSpace |
包装规格浮动空间 |
number |
startSellDate |
开始售卖时间 |
string (date-time) |
subTitle |
副标题 |
string |
tags |
标签 |
< Tag > array |
taxRate |
税率 |
string |
taxSortCode |
税率分类码 |
string |
tenant |
租户 |
string |
title |
标题 |
string |
type |
类型 |
string |
unit |
单位 |
string |
uuid |
样例 : |
string |
valuationType |
计价方式, 计数, 计重 |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
video |
主视频 |
string |
weight |
重量 |
number |
width |
宽度 |
number |
mbrPrice |
会员价 |
number |
3.71. PlatformFrontSpu
名称 | 说明 | 类型 |
---|---|---|
platform |
平台 |
|
name |
名称 |
string |
image |
主图 |
string |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
properties |
商品销售属性 |
< 商品销售属性 > array |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
description |
描述 |
string |
attributes |
商品特性 |
< 商品特性 > array |
customFields |
自定义属性 |
< 商品参数 > array |
type |
spu类型 |
string |
skus |
sku信息 |
< 平台前台Sku > array |
3.72. PlatformFrontSpu查询条件
名称 | 说明 | 类型 |
---|---|---|
platformIdEq |
平台ID等于 |
string |
platformIdIn |
平台ID在…范围内 |
< string > array |
frontSkuIdEq |
前台SKUId等于 |
string |
frontSkuIdIn |
前台SKUId在…范围 |
< string > array |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.73. PlatformShopFrontSku查询条件
名称 | 说明 | 类型 |
---|---|---|
platformIdEq |
平台ID等于 |
string |
platformIdIn |
平台ID在…范围内 |
< string > array |
shopIdEq |
门店ID等于 |
string |
shopIdIn |
门店ID在…范围内 |
< string > array |
frontSkuIdEq |
前台SKUId等于 |
string |
frontSkuIdIn |
前台SKUId在…范围 |
< string > array |
platformSkuIdIn |
平台前台SKUId在…范围 |
< string > array |
hasPlatformSkuId |
是否存在平台Sku |
boolean |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.74. SKU查询条件
名称 | 说明 | 类型 |
---|---|---|
brandNameLike |
品牌名称类似于 |
string |
businessTypeEq |
经营方式等于 |
string |
categoryIdIn |
分类ID在…范围内 |
< string > array |
codeEq |
code等于 |
string |
codeIn |
代码在…范围 |
< string > array |
codeLike |
代码类似于 |
string |
comboSkuIdIn |
子商品包含 |
< string > array |
comboSkuIdLike |
子商品SKUID类似于 |
string |
comboTypeEq |
sku类型等于,普通/组合 |
string |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
firstSaleGt |
售卖时间起始于 |
string (date-time) |
firstSaleLt |
售卖时间截止于 |
string (date-time) |
goodsIdIn |
goodsId在…范围内 |
< string > array |
goodsIdLike |
goodsId类似于 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
idLike |
Id类似于 |
string |
idNotIn |
ID不在在…范围内 |
< string > array |
image |
主图是否为空 |
boolean |
inputCodeCodeEq |
商品条码等于 |
string |
inputCodeCodeIn |
商品条码在…范围内 |
< string > array |
inputCodeCodeStartWith |
商品条码起始于 |
string |
inputCodeQpcEq |
商品规格等于 |
number |
inputCodeQpcNotEq |
商品规格不等于 |
number |
inputCodeTypeEq |
输入码类型等于 |
string |
keyword |
关键字等于,sku的名称/ID/编码/条码/GoodID 的模糊查询 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
nameLike |
名称类似于 |
string |
orgIdEq |
orgId等于 |
string |
orgTypeEq |
orgType等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
qualifiedEq |
合格标记等于(合格、不合格)… |
boolean |
saleStatusEq |
sku售卖状态 |
string |
saleTypeEq |
sku销售方式等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
spuIdEq |
spuId等于 |
string |
typeEq |
sku类型等于 |
string |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.75. SearchRequest
名称 | 说明 | 类型 |
---|---|---|
collapse |
字段折叠 |
object |
conditions |
查询条件,多个之间AND关系 |
< Condition > array |
fields |
返回字段,不传则默认返回所有字段 |
< string > array |
index |
INDEX |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序条件 |
< Sort > array |
type |
TYPE |
string |
unionConditions |
联合查询条件,多个之间AND关系 |
< UnionCondition > array |
3.76. SearchResponse
名称 | 说明 | 类型 |
---|---|---|
documents |
文档列表 |
< 文档 > array |
page |
页号 |
integer (int32) |
pageCount |
当前页 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
total |
总数 |
integer (int32) |
3.77. ShopSkuInv
门店商品库存
名称 | 说明 | 类型 |
---|---|---|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
qty |
可用库存数 |
number |
shopId |
门店代码 |
string |
skuId |
SKUID |
string |
source |
库存来源 |
string |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.78. ShopSkuInvFilter
门店商品库存查询条件
名称 | 说明 | 类型 |
---|---|---|
fetchParts |
级联查询信息 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
shopIdIn |
门店在…范围内 |
< string > array |
skuIdIn |
SkuId在…范围内 |
< string > array |
sorts |
排序字段集合 |
< Sort > array |
3.79. ShopSkuPrice
门店商品价格
名称 | 说明 | 类型 |
---|---|---|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
mbrPrice |
会员价 |
number |
price |
售价 |
number |
shopId |
门店ID |
string |
skuId |
商品ID |
string |
tenant |
租户 |
string |
unitPrice |
标准售价 |
number |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.80. ShopSkuPriceFilter
名称 | 说明 | 类型 |
---|---|---|
fetchParts |
级联查询信息 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
shopIdIn |
样例 : |
< string > array |
skuIdIn |
样例 : |
< string > array |
skuIdLike |
SkuId类似于 |
string |
skuIdStartWith |
SkuId起始于 |
string |
sorts |
排序字段集合 |
< Sort > array |
3.81. Sort
名称 | 说明 | 类型 |
---|---|---|
desc |
排序方向 |
boolean |
sortKey |
排序字段 |
string |
3.82. SourceKV
名称 | 说明 | 类型 |
---|---|---|
key |
KEY等于 |
string |
value |
值类似于 |
string |
3.83. Spu
名称 | 说明 | 类型 |
---|---|---|
attributes |
商品特性 |
< 商品特性 > array |
createInfo |
样例 : |
|
customFields |
自定义属性 |
< 商品参数 > array |
deleted |
已删除 |
boolean |
description |
描述 |
string |
id |
ID |
string |
image |
主图 |
string |
images |
副图 |
< string > array |
lastModifyInfo |
样例 : |
|
name |
名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
properties |
销售属性 |
< spu商品销售属性 > array |
skus |
sku信息 |
< SKU > array |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.84. Spu查询条件
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
idLike |
Id类似于 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
nameLike |
名称类似于 |
string |
orgIdEq |
orgId等于 |
string |
orgTypeEq |
orgType等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
skuContains |
包含skuId |
string |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.85. Tag
名称 | 说明 | 类型 |
---|---|---|
color |
样例 : |
string |
name |
样例 : |
string |
3.86. SkuImageList
商品图片列表对象
名称 | 说明 | 类型 |
---|---|---|
SkuImages |
上传的商品图片列表 |
< SkuImage > array |
3.87. SkuImage
商品图片对象
名称 | 说明 | 类型 |
---|---|---|
detailImages |
详细图片 |
< ImageDetail > array |
image |
主图 |
|
skuId |
商品ID |
string |
subImages |
附图 |
< ImageDetail > array |
3.88. ImageDetail
图片明细对象
名称 | 说明 | 类型 |
---|---|---|
url |
图片url |
string |
sort |
排序,图片的序号,序号越小排在越前面 |
integer (int32) |
3.89. UnionCondition
名称 | 说明 | 类型 |
---|---|---|
orConditions |
OR查询条件 |
< Condition > array |
3.90. Version
名称 | 说明 | 类型 |
---|---|---|
build |
样例 : |
< string > array |
buildText |
样例 : |
string |
empty |
样例 : |
boolean |
major |
样例 : |
< string > array |
majorText |
样例 : |
string |
milestone |
样例 : |
< string > array |
milestoneText |
样例 : |
string |
s |
样例 : |
< string > array |
text |
样例 : |
string |
3.91. spu商品销售属性
名称 | 说明 | 类型 |
---|---|---|
name |
名称 |
string |
values |
值 |
< string > array |
3.92. 内容修饰
名称 | 说明 | 类型 |
---|---|---|
beginDate |
起始时间日期 |
string (date-time) |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
enabled |
是否上线 |
boolean |
endDate |
截止时间日期 |
string (date-time) |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
lines |
内容修饰明细 |
< 内容修饰明细 > array |
name |
名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.93. 内容修饰明细
名称 | 说明 | 类型 |
---|---|---|
badgeId |
角标Id |
string |
badgePlatformIds |
角标平台Id |
< string > array |
isEnableBadge |
是否添加角标 |
boolean |
isEnablePrefix |
是否添加前缀 |
boolean |
prefixs |
前缀 |
< string > array |
shopIds |
shopId |
< string > array |
skuId |
skuId |
string |
3.94. 内容修饰查询筛选条件
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
dateBeginGtEq |
开始日期大于等于 |
string (date-time) |
dateBeginLt |
开始日期小于 |
string (date-time) |
dateBeginLtEq |
开始日期小于等于 |
string (date-time) |
dateEndGtEq |
结束日期大于等于 |
string (date-time) |
dateEndLt |
结束日期小于 |
string (date-time) |
dateEndLtEq |
结束日期小于等于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
enableEq |
是否上线 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyword |
名称,代码模糊 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
orgIdEq |
orgId等于 |
string |
orgTypeEq |
orgType等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
skuIdIn |
SKUID在…之中 |
< string > array |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.95. 内容投放
名称 | 说明 | 类型 |
---|---|---|
begin |
起始时间日期 |
string (date-time) |
countDown |
是否显示倒计时 |
boolean |
createInfo |
样例 : |
|
cycle |
是否周期 |
boolean |
cycleConditions |
周期条件 |
< 内容投放周期条件 > array |
deleted |
已删除 |
boolean |
enabled |
状态 |
boolean |
end |
截止时间日期 |
string (date-time) |
id |
ID |
string |
image |
图片 |
string |
lastModifyInfo |
样例 : |
|
name |
名称 |
string |
pageParams |
页面参数 |
object |
placeId |
资源位id |
string |
placeNo |
序号 |
integer (int32) |
platformId |
平台id |
string |
remark |
备注 |
string |
stayTime |
停留时间 |
integer (int32) |
targetPage |
跳转页面 |
string |
targetType |
投放目标类型 |
string |
targets |
投放目标 |
< string > array |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.96. 内容投放周期条件
名称 | 说明 | 类型 |
---|---|---|
hourBegin |
起始小时 |
integer (int32) |
hourEnd |
截止小时 |
integer (int32) |
minuteBegin |
起始分钟 |
integer (int32) |
minuteEnd |
截止分钟 |
integer (int32) |
orderNo |
序号 |
integer (int32) |
3.97. 内容投放查询筛选条件
名称 | 说明 | 类型 |
---|---|---|
dateBeginLt |
开始日期小于 |
string (date-time) |
dateEndGtEq |
结束日期大于等于 |
string (date-time) |
enable |
状态 |
boolean |
fetchParts |
级联查询信息 |
string |
hourBeginLtEq |
时间段开始小时小于等于 |
integer (int32) |
hourEndGtEq |
时间段结束小时大于等于 |
integer (int32) |
minuteBeginLtEq |
时间段开始分钟小于等于 |
integer (int32) |
minuteEndGtEq |
时间段结束分钟大于等于 |
integer (int32) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
placeIdEq |
资源位id |
string |
placeIdIn |
资源位id |
< string > array |
placeNoEq |
源位序号 |
integer (int32) |
platformIdEq |
平台id等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
3.98. 内容投放的位置
名称 | 说明 | 类型 |
---|---|---|
channel |
渠道 |
string |
code |
资源代码 |
string |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
imageUrl |
图片Url |
string |
lastModifyInfo |
样例 : |
|
name |
名称 |
string |
orderNo |
序号 |
integer (int32) |
platformId |
平台id |
string |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.99. 内容模板查询
名称 | 说明 | 类型 |
---|---|---|
createGt |
模板创建时间起始于 |
string (date-time) |
createLt |
模板创建时间截止于 |
string (date-time) |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyword |
关键字 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
placeIdEq |
内容资源位代码等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
updateGt |
模板更新时间起始于 |
string (date-time) |
updateLt |
模板更新时间截止于 |
string (date-time) |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.100. 分类查询条件
名称 | 说明 | 类型 |
---|---|---|
codeEq |
代码等于 |
string |
codeIn |
代码在…范围内 |
< string > array |
codeLike |
代码类似于 |
string |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyword |
代码名称类似于 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
nameLike |
名称类似于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
pathStartWidth |
路径开始于 |
string |
sorts |
排序字段集合 |
< Sort > array |
upperEq |
上级分类等于 |
string |
upperIn |
上级分类在….范围内 |
< string > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.101. 区域
名称 | 说明 | 类型 |
---|---|---|
points |
区域点位 |
< Point > array |
radius |
半径 |
number |
type |
区域类型, circle(圆形区域), polygon(多边形区域), lnglat(经纬度区域) |
string |
3.102. 品牌
名称 | 说明 | 类型 |
---|---|---|
code |
品牌代码 |
string |
id |
品牌id |
string |
name |
品牌名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
path |
品牌路径 |
string |
upper |
上级品牌 |
string |
3.103. 品牌查询条件
名称 | 说明 | 类型 |
---|---|---|
codeEq |
代码等于 |
string |
codeStartWith |
代码起始于 |
string |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
nameLike |
名称类似于 |
string |
orgIdEq |
所属组织ID等于 |
string |
orgTypeEq |
所属组织类型等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序字段集合 |
< Sort > array |
upperEq |
父品牌等于 |
string |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.104. 商品分类
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
id |
样例 : |
string |
name |
分类名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
path |
分类路径 |
string |
upper |
上级分类 |
string |
3.105. 商品参数
名称 | 说明 | 类型 |
---|---|---|
name |
名称 |
string |
value |
值 |
string |
3.106. 商品特性
名称 | 说明 | 类型 |
---|---|---|
name |
名称 |
string |
options |
可选值 |
< string > array |
3.107. 商品销售属性
名称 | 说明 | 类型 |
---|---|---|
name |
名称 |
string |
value |
值 |
string |
3.108. 地址
名称 | 说明 | 类型 |
---|---|---|
cityId |
城市id |
string |
cityName |
城市名称 |
string |
country |
国家 |
string |
detailAddress |
详细地址 |
string |
districtId |
地区id |
string |
districtName |
地区名称 |
string |
latitude |
纬度 |
string |
longitude |
经度 |
string |
postcode |
邮编 |
string |
provinceId |
省份id |
string |
provinceName |
身份名称 |
string |
streetId |
街道id |
string |
streetName |
街道名称 |
string |
3.109. 地址库
名称 | 说明 | 类型 |
---|---|---|
childrens |
子级地址 |
< 地址库 > array |
id |
id |
string |
level |
层级 |
integer (int32) |
name |
名称 |
string |
pinyin |
拼音 |
string |
upper |
上级 |
string |
uuid |
样例 : |
string |
3.110. 平台前台Sku
名称 | 说明 | 类型 |
---|---|---|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
frontSkuId |
前台SKU_ID |
string |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
platformId |
平台ID |
string |
sku |
sku信息 |
|
frontSku |
前台SKU |
|
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
freightTemplate |
运费模板id |
string |
3.111. 平台类目
名称 | 说明 | 类型 |
---|---|---|
children |
子类目 |
< 平台类目 > array |
code |
代码 |
string |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
image |
图片 |
string |
lastModifyInfo |
样例 : |
|
name |
名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
path |
路径 |
string |
platformId |
平台id |
string |
sort |
排序值 |
integer (int32) |
tenant |
租户 |
string |
type |
类型 |
string |
upperId |
上级 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.112. 平台类目商品
名称 | 说明 | 类型 |
---|---|---|
orgId |
组织id |
string |
orgType |
组织类型 |
string |
platformCategoryId |
平台类目id |
string |
platformCategoryType |
平台类目类型 |
string |
platformId |
平台id |
string |
skuId |
商品SKUID |
string |
sort |
排序值 |
integer (int32) |
tenant |
租户 |
string |
uuid |
样例 : |
string |
3.113. 平台类目商品查询条件
名称 | 说明 | 类型 |
---|---|---|
fetchParts |
级联查询信息 |
string |
orgIdEq |
组织id等于 |
string |
orgTypeEq |
组织类型等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
platformCategoryIdEq |
平台类目id等于 |
string |
platformCategoryIdIn |
平台类目id在之中 |
< string > array |
platformCategoryTypeEq |
平台类目类型等于 |
string |
platformCategoryTypeIn |
平台类目类型在之中 |
< string > array |
platformIdEq |
平台id等于 |
string |
platformIdIn |
平台id在之中 |
< string > array |
skuIdIn |
商品SKUID在之中 |
< string > array |
skuIdLike |
商品SKUID类似于 |
string |
sorts |
排序字段集合 |
< Sort > array |
3.114. 平台类目查询条件
名称 | 说明 | 类型 |
---|---|---|
codeIn |
code在…范围内 |
< string > array |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
nameEq |
名称等于 |
string |
nameIn |
名称在…范围内 |
< string > array |
orgIdEq |
组织id等于 |
string |
orgTypeEq |
组织类型等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
pathStartWith |
路径起始于 |
string |
platformIdEq |
平台id等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
typeEq |
类型等于 |
string |
upperIdEq |
上级类目等于 |
string |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.115. 平台门店
名称 | 说明 | 类型 |
---|---|---|
associateShop |
关联门店 |
|
businessHour |
平台门店营业时间 |
< string > array |
businessState |
平台门店营业状态 |
enum (normal, rest, closed) |
code |
平台门店代码, 对应平台上的门店id |
string |
configs |
平台门店配置 |
< string, string > map |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
enabled |
是否启用 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
merchant |
平台商家 |
|
name |
平台门店名称 |
string |
platform |
平台 |
|
state |
平台门店状态 |
enum (applying, opened, closed) |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.116. 平台门店分类查询条件
名称 | 说明 | 类型 |
---|---|---|
codeEq |
代码等于 |
string |
codeIn |
代码在…范围内 |
< string > array |
fetchParts |
级联查询信息 |
string |
hasSku |
样例 : |
boolean |
idEq |
id等于 |
string |
keyword |
代码名称类似于 |
string |
upperEq |
上级分类等于 |
string |
3.117. 平台门店商品
名称 | 说明 | 类型 |
---|---|---|
attach |
附件信息 |
|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
enabled |
是否上架 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
platform |
平台 |
|
saleStatus |
是否可售卖 |
boolean |
shop |
门店 |
|
sku |
sku |
|
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.118. 平台门店商品查询条件
名称 | 说明 | 类型 |
---|---|---|
attachFilter |
附加信息查询条件 |
|
brandIdIn |
商品品牌ID在列表… |
< string > array |
brandIdNotIn |
商品品牌ID不在列表… |
< string > array |
categoryIdIn |
商品平台分类ID在列表… |
< string > array |
categoryIdNotIn |
商品平台分类ID不在在列表… |
< string > array |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
enabledEq |
是否启用 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
平台门店商品ID在列表… |
< string > array |
keyword |
关键字等于,sku的名称/ID/条码/编码的模糊查询 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
platformCategoryIdEq |
平台分类id等于 |
string |
platformCategoryIdIn |
平台分类id在..范围 |
< string > array |
platformIdEq |
平台ID等于 |
string |
priceRange |
商品价格范围 |
< number > array |
shopCodeEq |
门店代码等于 |
string |
shopIdEq |
门店ID等于 |
string |
shopIdIn |
门店ID在列表… |
< string > array |
skuCodeEq |
样例 : |
string |
skuFetchParts |
sku级联查询信息 |
string |
skuIdIn |
商品skuID在列表… |
< string > array |
skuIdNotIn |
商品skuID不在列表… |
< string > array |
skuInputCodeCodeEq |
商品条码等于 |
string |
skuInputCodeCodeIn |
商品条码在…范围 |
< string > array |
skuSaleStatusEq |
商品可售状态等于 |
string |
skuSpuIdEq |
商品spuID等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
upperPlatformCategoryIdEq |
平台分类id等于 |
string |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.119. 平台门店商品索引查询条件
名称 | 说明 | 类型 |
---|---|---|
conditions |
查询条件,多个之间AND关系 |
< Condition > array |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序条件 |
< Sort > array |
unionConditions |
联合查询条件,多个之间AND关系 |
< UnionCondition > array |
3.120. 平台门店商品附件信息
名称 | 说明 | 类型 |
---|---|---|
fields |
数据 |
object |
id |
id |
string |
3.121. 平台门店商品附件信息查询条件
名称 | 说明 | 类型 |
---|---|---|
conditions |
查询条件,多个之间AND关系 |
< Condition > array |
unionConditions |
联合查询条件,多个之间AND关系 |
< UnionCondition > array |
3.122. 平台门店查询条件
名称 | 说明 | 类型 |
---|---|---|
businessStateEq |
营业状态等于 |
string |
cityIdEq |
所属城市等于 |
string |
codeEq |
平台门店代码等于 |
string |
codeIdIn |
平台门店代码在….范围 |
< string > array |
codeStartWith |
平台门店代码起始于 |
string |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
hasAssociateShop |
是否有关联门店 |
boolean |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyLike |
平台门店代码, 门店代码, 门店名称类似于 |
string |
merchantCodeIn |
平台商家代码在什么范围内 |
< string > array |
merchantCodeStartWith |
平台商家代码起始于 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
platformIdEq |
平台等于 |
string |
shopCodeIn |
门店代码在..范围 |
< string > array |
shopCodeStartWith |
门店代码起始于 |
string |
shopIdEq |
门店Id等于 |
string |
shopIdIn |
门店Id在..范围 |
< string > array |
shopIdLike |
门店Id类似于 |
string |
shopNameLike |
门店名称类似于 |
string |
shopTypeEq |
门店类型等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
stateEq |
平台门店状态等于 |
enum (applying, opened, closed) |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.123. 平台门店类目
名称 | 说明 | 类型 |
---|---|---|
children |
子类目 |
< 平台门店类目 > array |
code |
代码 |
string |
createInfo |
样例 : |
|
id |
平台类目id |
string |
lastModifyInfo |
样例 : |
|
name |
名称 |
string |
path |
路径 |
string |
platformId |
平台id |
string |
shopId |
门店id |
string |
sort |
排序值 |
integer (int32) |
tenant |
租户 |
string |
type |
平台类目类型 |
string |
upperId |
上级 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.124. 排序规则
名称 | 说明 | 类型 |
---|---|---|
createInfo |
样例 : |
|
dataKey |
数据主键 |
string |
dataType |
排序数据类型 |
string |
deleted |
已删除 |
boolean |
id |
标识 |
string |
lastModifyInfo |
样例 : |
|
orgId |
组织id |
string |
orgType |
组织类型 |
string |
platformId |
平台id |
string |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.125. 排序规则查询条件
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
dataTypeEq |
数据类型等于 |
string |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
platformIdEq |
平台id等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.126. 数据归档
名称 | 说明 | 类型 |
---|---|---|
businessKey |
业务主键 |
string |
content |
数据内容 |
object |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
tenant |
租户 |
string |
type |
类型 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.127. 数据归档查询条件
名称 | 说明 | 类型 |
---|---|---|
bizKeyEq |
业务主键等于 |
string |
bizKeyIn |
业务主键在..范围内 |
< string > array |
bizKeyNotIn |
业务主键不在..范围内 |
< string > array |
contentIn |
内容在什么范围 |
< SourceKV > array |
contentLike |
内容匹配 |
< SourceKV > array |
fetchParts |
级联查询信息 |
string |
keywordEq |
关键字匹配 |
< SourceKV > array |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序字段集合 |
< Sort > array |
typeEq |
类型等于 |
string |
3.128. 文档
名称 | 说明 | 类型 |
---|---|---|
fields |
文档数据 |
object |
id |
文档id |
string |
index |
索引index |
string |
type |
索引type |
string |
3.129. 联系信息
名称 | 说明 | 类型 |
---|---|---|
email |
联系人邮箱 |
string |
fax |
联系人传真 |
string |
mobile |
联系人手机 |
string |
name |
联系人名称 |
string |
telephone |
联系人电话 |
string |
3.130. 角标
名称 | 说明 | 类型 |
---|---|---|
code |
代码 |
string |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
name |
名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
purpose |
用途 |
string |
template |
模版 |
string |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.131. 角标查询筛选条件
名称 | 说明 | 类型 |
---|---|---|
codeIn |
code在…内 |
< string > array |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyword |
关键字等于,名称/code 的模糊查询 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
orgIdEq |
orgId等于 |
string |
orgTypeEq |
orgType等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
purposeEq |
用途 |
string |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.132. 详情描述
名称 | 说明 | 类型 |
---|---|---|
content |
内容 |
string |
order |
排序 |
integer (int32) |
type |
类型 |
string |
3.133. 输入码
名称 | 说明 | 类型 |
---|---|---|
code |
代码 |
string |
qpc |
规格 |
number |
qpcStr |
规格说明 |
string |
type |
类型 |
string |
unit |
单位 |
string |
weight |
重量 |
number |
3.134. 运费配置
名称 | 说明 | 类型 |
---|---|---|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
deliveryFee |
配送费 |
number |
freeSelfTake |
自提订单免起送价 |
boolean |
id |
ID |
string |
incrByWeight |
开启重量费用计价 |
boolean |
lastModifyInfo |
样例 : |
|
orgId |
组织id |
string |
orgType |
组织类型 |
string |
packFee |
打包费 |
number |
platformId |
平台id |
string |
regions |
配送区域 |
< 区域 > array |
startFee |
起送价 |
number |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
weightFeeRule |
费用计价规则 |
3.135. 运费配置查询条件
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
orgIdEq |
样例 : |
string |
orgIdIn |
样例 : |
< string > array |
orgTypeEq |
样例 : |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.136. 选项
名称 | 说明 | 类型 |
---|---|---|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
key |
选项名 |
string |
lastModifyInfo |
样例 : |
|
parameters |
参数 |
< Parameter > array |
tenant |
租户 |
string |
type |
类型 |
string |
uuid |
样例 : |
string |
value |
选项值 |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.137. 配送方式
名称 | 说明 | 类型 |
---|---|---|
bizKey |
业务主键 |
string |
code |
代码 |
string |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
enabled |
是否启用 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
name |
名称 |
string |
orgId |
组织id |
string |
orgType |
组织类型 |
string |
platformId |
平台id, 不区分平台则用-表示 |
string |
tenant |
租户 |
string |
type |
类型,shop/sku |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.138. 配送方式查询条件
名称 | 说明 | 类型 |
---|---|---|
bizKeyEq |
业务主键等于 |
string |
bizKeyIn |
业务主键等于 |
< string > array |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
orgIdEq |
组织id等于 |
string |
orgTypeEq |
组织类型等于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
platformIdEq |
平台id等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
typeEq |
业务类型等于 |
string |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.139. 配送费重量规则
名称 | 说明 | 类型 |
---|---|---|
base |
基础重量 |
number |
offset |
偏移重量,每增加多少重量 |
number |
offsetFee |
偏移价格,每增加多少重量,增加多少费用 |
number |
3.140. 门店
名称 | 说明 | 类型 |
---|---|---|
address |
地址信息 |
|
businessCircles |
商圈 |
< string > array |
businessHour |
营业时间 |
string |
code |
代码 |
string |
complainPhoneHour |
客诉服务时间 |
string |
complainPhoneNumber |
客诉电话 |
string |
configs |
门店配置 |
< string, string > map |
contact |
联系信息 |
|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
descriptions |
详情信息 |
< 详情描述 > array |
enabled |
启禁用 |
boolean |
facadeImage |
店头照 |
string |
id |
ID |
string |
image |
主图 |
string |
images |
副图 |
< string > array |
lastModifyInfo |
样例 : |
|
level |
等级 |
string |
name |
名称 |
string |
remaindPhoneNumber |
催单电话 |
string |
servicePhoneNumber |
服务电话 |
string |
tags |
标签 |
< Tag > array |
tenant |
租户 |
string |
type |
门店类型 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.141. 门店商品
名称 | 说明 | 类型 |
---|---|---|
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
enabled |
是否上架 |
boolean |
id |
ID |
string |
lastModifyInfo |
样例 : |
|
saleStatus |
是否可售卖 |
boolean |
shop |
门店 |
|
sku |
商品 |
|
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |
3.142. 门店商品查询条件
名称 | 说明 | 类型 |
---|---|---|
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyword |
关键字等于,sku的名称/ID/编码/条码 的模糊查询 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
shopIdEq |
shopIdEq等于 |
string |
skuBusinessTypeEq |
经营方式等于 |
string |
skuIdEq |
skuIdEq等于 |
string |
skuIdIn |
skuId在…范围 |
< string > array |
skuInputCodeCodeEq |
商品条码等于 |
string |
skuInputCodeCodeIn |
商品条码等于 |
< string > array |
skuSaleTypeEq |
sku销售方式等于 |
string |
skuTypeEq |
sku类型等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
uuidEq |
UUID等于 |
string |
uuidIn |
UUID在范围 |
< string > array |
3.143. 门店查询条件
名称 | 说明 | 类型 |
---|---|---|
addressLike |
地址类似于 |
string |
businessCircleEq |
商圈等于 |
string |
cityEq |
城市等于 |
string |
cityIn |
城市在…范围内 |
< string > array |
codeEq |
代码等于 |
string |
codeIn |
代码在…范围内 |
< string > array |
codeLike |
代码类似于 |
string |
codeNotIn |
代码不在…范围内 |
< string > array |
createdGt |
创建时间起始于 |
string (date-time) |
createdLt |
创建时间截止于 |
string (date-time) |
deletedEq |
是否已删除等于 |
boolean |
enabledEq |
启禁用状态 |
boolean |
fetchParts |
级联查询信息 |
string |
idEq |
ID等于 |
string |
idIn |
ID在…范围内 |
< string > array |
keyword |
名称、代码类似于 |
string |
levelEq |
门店等级等于 |
string |
modifiedGt |
最后修改时间起始于 |
string (date-time) |
modifiedLt |
最后修改时间截止于 |
string (date-time) |
nameLike |
名称类似于 |
string |
page |
页号 |
integer (int32) |
pageSize |
页记录数 |
integer (int32) |
platformEq |
对接平台等于 |
string |
sorts |
排序字段集合 |
< Sort > array |
typeEq |
门店类型等于 |
string |
typeIn |
门店类型在…范围内 |
< string > array |
uuidEq |
UUID等于 |
string |
uuidIn |
uuid在…范围内 |
< string > array |
3.144. 页面模板
名称 | 说明 | 类型 |
---|---|---|
content |
内容 |
object |
createInfo |
样例 : |
|
deleted |
已删除 |
boolean |
id |
ID |
string |
image |
图片 |
string |
lastModifyInfo |
样例 : |
|
name |
样例 : |
string |
placeId |
资源位id |
string |
remark |
备注 |
string |
tenant |
租户 |
string |
uuid |
样例 : |
string |
version |
样例 : |
integer (int64) |
versionTime |
样例 : |
string (date-time) |