资料中台文档

1. 第三方集成

在开始集成之前,你需要先知晓资料中台的OpenAPI地址以及访问appId和秘钥。

第三方应用接入资料中台主要有两种形式:

  • 直接调用资料中台提供的OpenAPI,通常有两种使用场景

    • 第三方不存储数据,在数据发生时候直接访问资料中台获取数据

    • 第三方存储数据,通过最后修改时间增量访问资料中台获取数据

  • 通过数据订阅,指定订阅的主题,并传入一个符合资料中台规则的SPI接口地址,当资料中台的数据满足订阅的目标条件时,将会回调SPI接口地址,主题主要也是两种类型

    • 通知型主题:将数据主键传给目标SPI,通常目标SPI需要先将通知存储下来,尽可能都接受通知,随后异步调度处理通知,通过调用资料中台的OpenAPI获取完整数据

    • 数据型主题:将完整数据传给目标SPI,通过目标SPI需要实时处理数据,并返回处理结果给资料中台

大致的交互图如下所示: 5e5bf2cbe4b0cc44b5b5ba91

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

ApplicationAbout

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

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

SKU查询条件

2.2.1.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«SKU»»

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

MasResponse«SKU»

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

MasResponse«SKU»

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查询条件

Spu查询条件

2.3.1.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«Spu»»

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

MasResponse«Spu»

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

MasPageResponse«List«内容修饰»»

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

MasResponse«内容修饰»

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

MasPageResponse«List«内容投放»»

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

MasResponse«内容投放»

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

MasPageResponse«List«内容投放的位置»»

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

MasResponse«内容投放的位置»

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

MasPageResponse«List«商品分类»»

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

MasResponse«商品分类»

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

MasPageResponse«List«品牌»»

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

MasResponse«品牌»

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
可选

查询条件

AddressFilter

2.9.1.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse«List«地址库»»

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查询条件

PlatformFrontSkuFilter

2.10.1.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«平台前台Sku»»

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

MasResponse«平台前台Sku»

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

MasResponse«List«平台类目»»

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

MasPageResponse«List«平台类目商品»»

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

MasPageResponse«List«平台门店»»

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

MasResponse«平台门店»

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

MasResponse«List«平台门店类目»»

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

MasPageResponse«List«平台门店商品»»

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

MasPageResponse«List«平台门店商品»»

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

MasResponse«平台门店商品»

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

MasPageResponse«List«排序规则»»

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
必填

查询条件

HotWordFilter

2.17.1.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«HotWord»»

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

MasPageResponse«List«数据归档»»

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

MasPageResponse«List«页面模板»»

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

MasResponse«页面模板»

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
必填

文档

MasRequest«List«文档»»

2.20.1.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse

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
必填

文档

RemoveDocRequest

2.20.2.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse

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
必填

文档

MasRequest«List«文档»»

2.20.3.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse

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
必填

搜索条件

SearchRequest

2.20.4.2. 响应
HTTP代码 说明 类型

200

OK

SearchResponse

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

MasResponse«文档»

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

MasPageResponse«List«角标»»

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

MasResponse«角标»

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
必填

新建选项

OptionsCreation

2.22.1.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse

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
必填

查询条件

OptionsFilter

2.22.2.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse«List«选项»»

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

MasResponse

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

MasResponse

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
必填

更新选项

OptionsUpdate

2.22.5.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse

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

MasResponse«List«运费配置»»

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

MasPageResponse«List«配送方式»»

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

MasResponse«List«运费配置»»

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

MasResponse«List«配送方式»»

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

MasResponse

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

MasPageResponse«List«门店»»

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

MasResponse

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

MasResponse

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.5. HTTP请求示例
请求 path
/v2/string/service/shop/string/enable
请求 query
{
  "operator" : "string"
}
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

MasResponse«门店»

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

MasResponse

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

MasPageResponse«List«门店商品»»

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

MasResponse«门店商品»

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
必填

商品价格集合

MasRequest«List«ShopSkuPrice»»

2.26.1.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse«Void»

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
必填

查询条件

ShopSkuPriceFilter

2.26.2.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«ShopSkuPrice»»

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
必填

商品价格集合

MasRequest«List«ShopSkuPrice»»

2.26.3.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse«Void»

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
必填

商品库存查询条件

ShopSkuInvFilter

2.27.1.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«ShopSkuInv»»

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
必填

商品库存集合

MasRequest«List«ShopSkuInv»»

2.27.2.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse«Void»

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条

SkuImageList

2.28.1.2. 响应
HTTP代码 说明 类型

200

OK

MasResponse

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

PlatformFrontSpu查询条件

2.29.1.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«PlatformFrontSpu»»

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

MasResponse«PlatformFrontSpu»

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

PlatformShopFrontSku查询条件

2.30.1.2. 响应
HTTP代码 说明 类型

200

OK

MasPageResponse«List«PlatformShopFrontSku»»

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

MasResponse«PlatformShopFrontSku»

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"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

desc
可选

是否降序
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

levelEq
可选

层级等于,省份1,城市2,区域3,街道4
样例 : 0

integer (int32)

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

nameEq
可选

名称等于
样例 : "string"

string

orgTypeInclude
可选

组织类型包含于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sortKey
可选

排序字段
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

upperEq
可选

上级地址等于
样例 : "string"

string

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.2. ApplicationAbout

名称 说明 类型

build
可选

样例 : "string"

string

commonTitle
可选

样例 : "string"

string

copyright
可选

样例 : "string"

string

groupId
可选

样例 : "string"

string

localeTitle
可选

样例 : "string"

string

site
可选

样例 : "string"

string

title
可选

样例 : "string"

string

version
可选

样例 : "Version"

Version

3.3. Condition

名称 说明 类型

field
可选

字段名
样例 : "string"

string

operator
可选

操作符
样例 : "string"

enum (equals, notQquals, in, notIn, rangeWithEqual, rangeWithNotEqual, startWidth, like, isNull, isNotNull)

parameters
可选

条件值
样例 : [ "object" ]

< object > array

3.4. HotWord

名称 说明 类型

begin
可选

样例 : "string"

string (date-time)

code
可选

样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

end
可选

样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

orgId
可选

样例 : "string"

string

orgType
可选

样例 : "string"

string

places
可选

样例 : [ "string" ]

< string > array

platformIds
可选

样例 : [ "string" ]

< string > array

skuIds
可选

样例 : [ "string" ]

< string > array

sort
可选

样例 : 0

integer (int32)

state
可选

样例 : "string"

enum (unpublished, online, offline, finished)

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

word
可选

样例 : "string"

string

3.5. HotWordFilter

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

dateBeginGtEq
可选

开始日期大于等于
样例 : "string"

string (date-time)

dateBeginLt
可选

开始日期小于
样例 : "string"

string (date-time)

dateBeginLtEq
可选

开始日期小于等于
样例 : "string"

string (date-time)

dateEndGtEq
可选

结束日期大于等于
样例 : "string"

string (date-time)

dateEndLt
可选

结束日期小于
样例 : "string"

string (date-time)

dateEndLtEq
可选

结束日期小于等于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyword
可选

名称,代码模糊
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

placeEq
可选

展示位
样例 : "string"

string

platformIdEq
可选

平台
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

stateEq
可选

状态
样例 : "string"

string

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.6. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

3.7. MasPageResponse«List«HotWord»»

名称 说明 类型

data
可选

样例 : [ "HotWord" ]

< HotWord > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.8. MasPageResponse«List«SKU»»

名称 说明 类型

data
可选

样例 : [ "SKU" ]

< SKU > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.9. MasPageResponse«List«PlatformFrontSpu»»

名称 说明 类型

data
可选

样例 : [ "PlatformFrontSpu" ]

< PlatformFrontSpu > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.10. MasPageResponse«List«PlatformShopFrontSku»»

名称 说明 类型

data
可选

样例 : [ "PlatformShopFrontSku" ]

< PlatformShopFrontSku > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.11. PlatformShopFrontSku

名称 说明 类型

platform
可选

平台
样例 : [ "IdName" ]

IdName

shop
可选

门店
样例 : [ "IdCodeName" ]

IdCodeName

frontSku
可选

前台SKU
样例 : [ "FrontSku" ]

FrontSku

enabled
可选

状态
样例 : true

boolean

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.12. IdCodeName

名称 说明 类型

id
可选

样例 : "string"

string

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

3.13. FrontSku

名称 说明 类型

frontSpuId
可选

前台SPUID
样例 : string

string

code
可选

代码
样例 : string

string

sku
可选

SKU
样例 : "SKU"

SKU

properties
可选

商品销售属性
样例 : [ "商品销售属性" ]

< 商品销售属性 > array

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

tmallBrandId
可选

天猫品牌id
样例 : "string"

string

tmallCategoryId
可选

天猫分类id
样例 : "string"

string

3.14. MasPageResponse«List«ShopSkuInv»»

名称 说明 类型

data
可选

样例 : [ "ShopSkuInv" ]

< ShopSkuInv > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.15. MasPageResponse«List«ShopSkuPrice»»

名称 说明 类型

data
可选

样例 : [ "ShopSkuPrice" ]

< ShopSkuPrice > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.16. MasPageResponse«List«Spu»»

名称 说明 类型

data
可选

样例 : [ "Spu" ]

< Spu > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.17. MasPageResponse«List«内容修饰»»

名称 说明 类型

data
可选

样例 : [ "内容修饰" ]

< 内容修饰 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.18. MasPageResponse«List«内容投放»»

名称 说明 类型

data
可选

样例 : [ "内容投放" ]

< 内容投放 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.19. MasPageResponse«List«内容投放的位置»»

名称 说明 类型

data
可选

样例 : [ "内容投放的位置" ]

< 内容投放的位置 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.20. MasPageResponse«List«品牌»»

名称 说明 类型

data
可选

样例 : [ "品牌" ]

< 品牌 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.21. MasPageResponse«List«商品分类»»

名称 说明 类型

data
可选

样例 : [ "商品分类" ]

< 商品分类 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.22. MasPageResponse«List«平台前台Sku»»

名称 说明 类型

data
可选

样例 : [ "平台前台Sku" ]

< 平台前台Sku > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.23. MasPageResponse«List«平台类目商品»»

名称 说明 类型

data
可选

样例 : [ "平台类目商品" ]

< 平台类目商品 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.24. MasPageResponse«List«平台门店»»

名称 说明 类型

data
可选

样例 : [ "平台门店" ]

< 平台门店 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.25. MasPageResponse«List«平台门店商品»»

名称 说明 类型

data
可选

样例 : [ "平台门店商品" ]

< 平台门店商品 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.26. MasPageResponse«List«排序规则»»

名称 说明 类型

data
可选

样例 : [ "排序规则" ]

< 排序规则 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.27. MasPageResponse«List«数据归档»»

名称 说明 类型

data
可选

样例 : [ "数据归档" ]

< 数据归档 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.28. MasPageResponse«List«角标»»

名称 说明 类型

data
可选

样例 : [ "角标" ]

< 角标 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.29. MasPageResponse«List«配送方式»»

名称 说明 类型

data
可选

样例 : [ "配送方式" ]

< 配送方式 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.30. MasPageResponse«List«门店»»

名称 说明 类型

data
可选

样例 : [ "门店" ]

< 门店 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.31. MasPageResponse«List«门店商品»»

名称 说明 类型

data
可选

样例 : [ "门店商品" ]

< 门店商品 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.32. MasPageResponse«List«页面模板»»

名称 说明 类型

data
可选

样例 : [ "页面模板" ]

< 页面模板 > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

样例 : true

boolean

total
可选

样例 : 0

integer (int32)

3.33. MasRequest«List«ShopSkuInv»»

名称 说明 类型

data
可选

请求数据
样例 : [ "ShopSkuInv" ]

< ShopSkuInv > array

3.34. MasRequest«List«ShopSkuPrice»»

名称 说明 类型

data
可选

请求数据
样例 : [ "ShopSkuPrice" ]

< ShopSkuPrice > array

3.35. MasRequest«List«文档»»

名称 说明 类型

data
可选

请求数据
样例 : [ "文档" ]

< 文档 > array

3.36. MasResponse

名称 说明 类型

data
可选

响应数据
样例 : "object"

object

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.37. MasResponse«List«地址库»»

名称 说明 类型

data
可选

响应数据
样例 : [ "地址库" ]

< 地址库 > array

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.38. MasResponse«List«平台类目»»

名称 说明 类型

data
可选

响应数据
样例 : [ "平台类目" ]

< 平台类目 > array

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.39. MasResponse«List«平台门店类目»»

名称 说明 类型

data
可选

响应数据
样例 : [ "平台门店类目" ]

< 平台门店类目 > array

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.40. MasResponse«List«运费配置»»

名称 说明 类型

data
可选

响应数据
样例 : [ "运费配置" ]

< 运费配置 > array

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.41. MasResponse«List«选项»»

名称 说明 类型

data
可选

响应数据
样例 : [ "选项" ]

< 选项 > array

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.42. MasResponse«List«配送方式»»

名称 说明 类型

data
可选

响应数据
样例 : [ "配送方式" ]

< 配送方式 > array

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.43. MasResponse«SKU»

名称 说明 类型

data
可选

响应数据
样例 : "SKU"

SKU

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.44. MasResponse«PlatformFrontSpu»

名称 说明 类型

data
可选

响应数据
样例 : "PlatformFrontSpu"

PlatformFrontSpu

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.45. MasResponse«PlatformShopFrontSku»

名称 说明 类型

data
可选

响应数据
样例 : "PlatformShopFrontSku"

PlatformShopFrontSku

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.46. MasResponse«Spu»

名称 说明 类型

data
可选

响应数据
样例 : "Spu"

Spu

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.47. MasResponse«Void»

名称 说明 类型

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.48. MasResponse«内容修饰»

名称 说明 类型

data
可选

响应数据
样例 : "内容修饰"

内容修饰

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.49. MasResponse«内容投放»

名称 说明 类型

data
可选

响应数据
样例 : "内容投放"

内容投放

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.50. MasResponse«内容投放的位置»

名称 说明 类型

data
可选

响应数据
样例 : "内容投放的位置"

内容投放的位置

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.51. MasResponse«品牌»

名称 说明 类型

data
可选

响应数据
样例 : "品牌"

品牌

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.52. MasResponse«商品分类»

名称 说明 类型

data
可选

响应数据
样例 : "商品分类"

商品分类

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.53. MasResponse«平台前台Sku»

名称 说明 类型

data
可选

响应数据
样例 : "平台前台Sku"

平台前台Sku

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.54. MasResponse«平台门店»

名称 说明 类型

data
可选

响应数据
样例 : "平台门店"

平台门店

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.55. MasResponse«平台门店商品»

名称 说明 类型

data
可选

响应数据
样例 : "平台门店商品"

平台门店商品

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.56. MasResponse«文档»

名称 说明 类型

data
可选

响应数据
样例 : "文档"

文档

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.57. MasResponse«角标»

名称 说明 类型

data
可选

响应数据
样例 : "角标"

角标

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.58. MasResponse«门店»

名称 说明 类型

data
可选

响应数据
样例 : "门店"

门店

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.59. MasResponse«门店商品»

名称 说明 类型

data
可选

响应数据
样例 : "门店商品"

门店商品

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.60. MasResponse«页面模板»

名称 说明 类型

data
可选

响应数据
样例 : "页面模板"

页面模板

echoCode
可选

响应吗
样例 : 0

integer (int32)

echoMessage
可选

响应信息
样例 : "string"

string

success
可选

是否成功
样例 : true

boolean

3.61. OperateInfo

名称 说明 类型

operator
可选

样例 : "Operator"

Operator

time
可选

样例 : "string"

string (date-time)

3.62. Operator

名称 说明 类型

fullName
可选

样例 : "string"

string

id
可选

样例 : "string"

string

namespace
可选

样例 : "string"

string

qualifiedId
可选

样例 : "string"

string

3.63. OptionsCreation

名称 说明 类型

key
必填

选项名
样例 : "string"

string

parameters
必填

参数
样例 : [ "Parameter" ]

< Parameter > array

value
必填

选项值
样例 : "string"

string

3.64. OptionsFilter

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

enableEq
可选

是否已启用等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyEq
可选

选项名等于
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.65. OptionsUpdate

名称 说明 类型

key
必填

选项名
样例 : "string"

string

parameters
必填

参数
样例 : [ "Parameter" ]

< Parameter > array

value
必填

选项值
样例 : "string"

string

3.66. Parameter

名称 说明 类型

name
可选

样例 : "string"

string

value
可选

样例 : "string"

string

3.67. PlatformFrontSkuFilter

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

frontSkuIdEq
可选

样例 : "string"

string

frontSkuIdIn
可选

样例 : [ "string" ]

< string > array

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

platformIdEq
可选

样例 : "string"

string

platformIdIn
可选

样例 : [ "string" ]

< string > array

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.68. Point

名称 说明 类型

latitude
可选

样例 : "string"

string

longitude
可选

样例 : "string"

string

order
可选

样例 : 0

integer (int32)

3.69. RemoveDocRequest

名称 说明 类型

docIds
可选

文档id列
样例 : [ "string" ]

< string > array

index
可选

索引index
样例 : "string"

string

type
可选

索引type
样例 : "string"

string

3.70. SKU

名称 说明 类型

attributes
可选

商品特性
样例 : [ "商品特性" ]

< 商品特性 > array

brand
可选

品牌
样例 : "品牌"

品牌

businessType
可选

经营方式, 经销,联营
样例 : "string"

string

category
可选

分类
样例 : "商品分类"

商品分类

code
可选

代码
样例 : "string"

string

comboType
可选

sku类型,普通/组合
样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

customFields
可选

自定义属性
样例 : [ "商品参数" ]

< 商品参数 > array

deleted
可选

已删除
样例 : true

boolean

description
可选

描述
样例 : "string"

string

descriptions
可选

图文详情
样例 : [ "详情描述" ]

< 详情描述 > array

enabled
可选

上下架状态
样例 : true

boolean

endSellDate
可选

结束售卖时间
样例 : "string"

string (date-time)

firstSaleTime
可选

首次售卖时间
样例 : "string"

string (date-time)

goodsId
可选

goodsId
样例 : "string"

string

height
可选

高度
样例 : 0.0

number

id
可选

ID
样例 : "string"

string

image
可选

主图
样例 : "string"

string

images
可选

副图
样例 : [ "string" ]

< string > array

inputCode
可选

样例 : "输入码"

输入码

inputCodes
可选

输入码
样例 : [ "输入码" ]

< 输入码 > array

items
可选

组合明细
样例 : [ "SKU" ]

< SKU > array

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

length
可选

长度
样例 : 0.0

number

marketPrice
可选

参考市场价
样例 : 0.0

number

name
可选

名称
样例 : "string"

string

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

properties
可选

商品销售属性
样例 : [ "商品销售属性" ]

< 商品销售属性 > array

purchasePrice
可选

参考进价
样例 : 0.0

number

qpc
可选

规格
样例 : 0.0

number

qpcStr
可选

规格说明
样例 : "string"

string

qualified
可选

是否合格, 可用于标记主图是否合格
样例 : true

boolean

quantity
可选

样例 : 0.0

number

saleStatus
可选

是否可售卖
样例 : true

boolean

saleType
可选

销售方式, 散装, 标准
样例 : "string"

string

spec
可选

包装规格
样例 : "string"

string

specFloatingSpace
可选

包装规格浮动空间
样例 : 0.0

number

startSellDate
可选

开始售卖时间
样例 : "string"

string (date-time)

subTitle
可选

副标题
样例 : "string"

string

tags
可选

标签
样例 : [ "Tag" ]

< Tag > array

taxRate
可选

税率
样例 : "string"

string

taxSortCode
可选

税率分类码
样例 : "string"

string

tenant
可选

租户
样例 : "string"

string

title
可选

标题
样例 : "string"

string

type
可选

类型
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

uuid
可选

样例 : "string"

string

valuationType
可选

计价方式, 计数, 计重
样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

video
可选

主视频
样例 : "string"

string

weight
可选

重量
样例 : 0.0

number

width
可选

宽度
样例 : 0.0

number

mbrPrice
可选

会员价
样例 : 0.0

number

3.71. PlatformFrontSpu

名称 说明 类型

platform
可选

平台
样例 : [ "IdName" ]

IdName

name
可选

名称
样例 : "string"

string

image
可选

主图
样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

properties
可选

商品销售属性
样例 : [ "商品销售属性" ]

< 商品销售属性 > array

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

description
可选

描述
样例 : "string"

string

attributes
可选

商品特性
样例 : [ "商品特性" ]

< 商品特性 > array

customFields
可选

自定义属性
样例 : [ "商品参数" ]

< 商品参数 > array

type
可选

spu类型
样例 : "string"

string

skus
可选

sku信息
样例 : [ "平台前台Sku" ]

< 平台前台Sku > array

3.72. PlatformFrontSpu查询条件

名称 说明 类型

platformIdEq
可选

平台ID等于
样例 : "string"

string

platformIdIn
可选

平台ID在…范围内
样例 : [ "string" ]

< string > array

frontSkuIdEq
可选

前台SKUId等于
样例 : "string"

string

frontSkuIdIn
可选

前台SKUId在…范围
样例 : [ "string" ]

< string > array

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.73. PlatformShopFrontSku查询条件

名称 说明 类型

platformIdEq
可选

平台ID等于
样例 : "string"

string

platformIdIn
可选

平台ID在…范围内
样例 : [ "string" ]

< string > array

shopIdEq
可选

门店ID等于
样例 : "string"

string

shopIdIn
可选

门店ID在…范围内
样例 : [ "string" ]

< string > array

frontSkuIdEq
可选

前台SKUId等于
样例 : "string"

string

frontSkuIdIn
可选

前台SKUId在…范围
样例 : [ "string" ]

< string > array

platformSkuIdIn
可选

平台前台SKUId在…范围
样例 : [ "string" ]

< string > array

hasPlatformSkuId
可选

是否存在平台Sku
样例 : true

boolean

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.74. SKU查询条件

名称 说明 类型

brandNameLike
可选

品牌名称类似于
样例 : "string"

string

businessTypeEq
可选

经营方式等于
样例 : "string"

string

categoryIdIn
可选

分类ID在…范围内
样例 : [ "string" ]

< string > array

codeEq
可选

code等于
样例 : "string"

string

codeIn
可选

代码在…范围
样例 : [ "string" ]

< string > array

codeLike
可选

代码类似于
样例 : "string"

string

comboSkuIdIn
可选

子商品包含
样例 : [ "string" ]

< string > array

comboSkuIdLike
可选

子商品SKUID类似于
样例 : "string"

string

comboTypeEq
可选

sku类型等于,普通/组合
样例 : "string"

string

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

firstSaleGt
可选

售卖时间起始于
样例 : "string"

string (date-time)

firstSaleLt
可选

售卖时间截止于
样例 : "string"

string (date-time)

goodsIdIn
可选

goodsId在…范围内
样例 : [ "string" ]

< string > array

goodsIdLike
可选

goodsId类似于
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

idLike
可选

Id类似于
样例 : "string"

string

idNotIn
可选

ID不在在…范围内
样例 : [ "string" ]

< string > array

image
可选

主图是否为空
样例 : true

boolean

inputCodeCodeEq
可选

商品条码等于
样例 : "string"

string

inputCodeCodeIn
可选

商品条码在…范围内
样例 : [ "string" ]

< string > array

inputCodeCodeStartWith
可选

商品条码起始于
样例 : "string"

string

inputCodeQpcEq
可选

商品规格等于
样例 : 0.0

number

inputCodeQpcNotEq
可选

商品规格不等于
样例 : 0.0

number

inputCodeTypeEq
可选

输入码类型等于
样例 : "string"

string

keyword
可选

关键字等于,sku的名称/ID/编码/条码/GoodID 的模糊查询
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

nameLike
可选

名称类似于
样例 : "string"

string

orgIdEq
可选

orgId等于
样例 : "string"

string

orgTypeEq
可选

orgType等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

qualifiedEq
可选

合格标记等于(合格、不合格)…
样例 : true

boolean

saleStatusEq
可选

sku售卖状态
样例 : "string"

string

saleTypeEq
可选

sku销售方式等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

spuIdEq
可选

spuId等于
样例 : "string"

string

typeEq
可选

sku类型等于
样例 : "string"

string

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.75. SearchRequest

名称 说明 类型

collapse
可选

字段折叠
样例 : "object"

object

conditions
可选

查询条件,多个之间AND关系
样例 : [ "Condition" ]

< Condition > array

fields
可选

返回字段,不传则默认返回所有字段
样例 : [ "string" ]

< string > array

index
可选

INDEX
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序条件
样例 : [ "Sort" ]

< Sort > array

type
可选

TYPE
样例 : "string"

string

unionConditions
可选

联合查询条件,多个之间AND关系
样例 : [ "UnionCondition" ]

< UnionCondition > array

3.76. SearchResponse

名称 说明 类型

documents
可选

文档列表
样例 : [ "文档" ]

< 文档 > array

page
可选

页号
样例 : 0

integer (int32)

pageCount
可选

当前页
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

total
可选

总数
样例 : 0

integer (int32)

3.77. ShopSkuInv

门店商品库存

名称 说明 类型

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

qty
必填

可用库存数
样例 : 155.0

number

shopId
必填

门店代码
样例 : "0001"

string

skuId
必填

SKUID
样例 : "1111"

string

source
可选

库存来源
样例 : "ERP"

string

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.78. ShopSkuInvFilter

门店商品库存查询条件

名称 说明 类型

fetchParts
可选

级联查询信息
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

shopIdIn
可选

门店在…范围内
样例 : [ "string" ]

< string > array

skuIdIn
可选

SkuId在…范围内
样例 : [ "string" ]

< string > array

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

3.79. ShopSkuPrice

门店商品价格

名称 说明 类型

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

mbrPrice
可选

会员价
样例 : 15.25

number

price
必填

售价
样例 : 12.25

number

shopId
必填

门店ID
样例 : "0001"

string

skuId
必填

商品ID
样例 : "54654"

string

tenant
可选

租户
样例 : "string"

string

unitPrice
可选

标准售价
样例 : 12.35

number

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.80. ShopSkuPriceFilter

名称 说明 类型

fetchParts
可选

级联查询信息
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

shopIdIn
可选

样例 : [ "string" ]

< string > array

skuIdIn
可选

样例 : [ "string" ]

< string > array

skuIdLike
可选

SkuId类似于
样例 : "string"

string

skuIdStartWith
可选

SkuId起始于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

3.81. Sort

名称 说明 类型

desc
可选

排序方向
样例 : true

boolean

sortKey
可选

排序字段
样例 : "string"

string

3.82. SourceKV

名称 说明 类型

key
可选

KEY等于
样例 : "string"

string

value
可选

值类似于
样例 : "string"

string

3.83. Spu

名称 说明 类型

attributes
可选

商品特性
样例 : [ "商品特性" ]

< 商品特性 > array

createInfo
可选

样例 : "OperateInfo"

OperateInfo

customFields
可选

自定义属性
样例 : [ "商品参数" ]

< 商品参数 > array

deleted
可选

已删除
样例 : true

boolean

description
可选

描述
样例 : "string"

string

id
可选

ID
样例 : "string"

string

image
可选

主图
样例 : "string"

string

images
可选

副图
样例 : [ "string" ]

< string > array

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

名称
样例 : "string"

string

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

properties
可选

销售属性
样例 : [ "spu商品销售属性" ]

< spu商品销售属性 > array

skus
可选

sku信息
样例 : [ "SKU" ]

< SKU > array

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.84. Spu查询条件

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

idLike
可选

Id类似于
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

nameLike
可选

名称类似于
样例 : "string"

string

orgIdEq
可选

orgId等于
样例 : "string"

string

orgTypeEq
可选

orgType等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

skuContains
可选

包含skuId
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.85. Tag

名称 说明 类型

color
可选

样例 : "string"

string

name
可选

样例 : "string"

string

3.86. SkuImageList

商品图片列表对象

名称 说明 类型

SkuImages
可选

上传的商品图片列表
样例 : [ "[_SkuImage ]" ]

< SkuImage > array

3.87. SkuImage

商品图片对象

名称 说明 类型

detailImages
可选

详细图片
样例 : [ "ImageDetail" ]

< ImageDetail > array

image
可选

主图
样例 : [ "ImageDetail" ]

ImageDetail

skuId
可选

商品ID
样例 : [ "string" ]

string

subImages
可选

附图
样例 : [ "ImageDetail" ]

< ImageDetail > array

3.88. ImageDetail

图片明细对象

名称 说明 类型

url
可选

图片url
样例 : "http://aa.png"

string

sort
可选

排序,图片的序号,序号越小排在越前面
样例 : 0

integer (int32)

3.89. UnionCondition

名称 说明 类型

orConditions
可选

OR查询条件
样例 : [ "Condition" ]

< Condition > array

3.90. Version

名称 说明 类型

build
可选

样例 : [ "string" ]

< string > array

buildText
可选

样例 : "string"

string

empty
可选

样例 : true

boolean

major
可选

样例 : [ "string" ]

< string > array

majorText
可选

样例 : "string"

string

milestone
可选

样例 : [ "string" ]

< string > array

milestoneText
可选

样例 : "string"

string

s
可选

样例 : [ "string" ]

< string > array

text
可选

样例 : "string"

string

3.91. spu商品销售属性

名称 说明 类型

name
可选

名称
样例 : "string"

string

values
可选


样例 : [ "string" ]

< string > array

3.92. 内容修饰

名称 说明 类型

beginDate
可选

起始时间日期
样例 : "string"

string (date-time)

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

enabled
可选

是否上线
样例 : true

boolean

endDate
可选

截止时间日期
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

lines
可选

内容修饰明细
样例 : [ "内容修饰明细" ]

< 内容修饰明细 > array

name
可选

名称
样例 : "string"

string

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.93. 内容修饰明细

名称 说明 类型

badgeId
可选

角标Id
样例 : "string"

string

badgePlatformIds
可选

角标平台Id
样例 : [ "string" ]

< string > array

isEnableBadge
可选

是否添加角标
样例 : true

boolean

isEnablePrefix
可选

是否添加前缀
样例 : true

boolean

prefixs
可选

前缀
样例 : [ "string" ]

< string > array

shopIds
可选

shopId
样例 : [ "string" ]

< string > array

skuId
可选

skuId
样例 : "string"

string

3.94. 内容修饰查询筛选条件

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

dateBeginGtEq
可选

开始日期大于等于
样例 : "string"

string (date-time)

dateBeginLt
可选

开始日期小于
样例 : "string"

string (date-time)

dateBeginLtEq
可选

开始日期小于等于
样例 : "string"

string (date-time)

dateEndGtEq
可选

结束日期大于等于
样例 : "string"

string (date-time)

dateEndLt
可选

结束日期小于
样例 : "string"

string (date-time)

dateEndLtEq
可选

结束日期小于等于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

enableEq
可选

是否上线
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyword
可选

名称,代码模糊
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

orgIdEq
可选

orgId等于
样例 : "string"

string

orgTypeEq
可选

orgType等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

skuIdIn
可选

SKUID在…之中
样例 : [ "string" ]

< string > array

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.95. 内容投放

名称 说明 类型

begin
可选

起始时间日期
样例 : "string"

string (date-time)

countDown
可选

是否显示倒计时
样例 : true

boolean

createInfo
可选

样例 : "OperateInfo"

OperateInfo

cycle
可选

是否周期
样例 : true

boolean

cycleConditions
可选

周期条件
样例 : [ "内容投放周期条件" ]

< 内容投放周期条件 > array

deleted
可选

已删除
样例 : true

boolean

enabled
可选

状态
样例 : true

boolean

end
可选

截止时间日期
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

image
可选

图片
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

名称
样例 : "string"

string

pageParams
可选

页面参数
样例 : "object"

object

placeId
可选

资源位id
样例 : "string"

string

placeNo
可选

序号
样例 : 0

integer (int32)

platformId
可选

平台id
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

stayTime
可选

停留时间
样例 : 0

integer (int32)

targetPage
可选

跳转页面
样例 : "string"

string

targetType
可选

投放目标类型
样例 : "string"

string

targets
可选

投放目标
样例 : [ "string" ]

< string > array

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.96. 内容投放周期条件

名称 说明 类型

hourBegin
可选

起始小时
样例 : 0

integer (int32)

hourEnd
可选

截止小时
样例 : 0

integer (int32)

minuteBegin
可选

起始分钟
样例 : 0

integer (int32)

minuteEnd
可选

截止分钟
样例 : 0

integer (int32)

orderNo
可选

序号
样例 : 0

integer (int32)

3.97. 内容投放查询筛选条件

名称 说明 类型

dateBeginLt
可选

开始日期小于
样例 : "string"

string (date-time)

dateEndGtEq
可选

结束日期大于等于
样例 : "string"

string (date-time)

enable
可选

状态
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

hourBeginLtEq
可选

时间段开始小时小于等于
样例 : 0

integer (int32)

hourEndGtEq
可选

时间段结束小时大于等于
样例 : 0

integer (int32)

minuteBeginLtEq
可选

时间段开始分钟小于等于
样例 : 0

integer (int32)

minuteEndGtEq
可选

时间段结束分钟大于等于
样例 : 0

integer (int32)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

placeIdEq
可选

资源位id
样例 : "string"

string

placeIdIn
可选

资源位id
样例 : [ "string" ]

< string > array

placeNoEq
可选

源位序号
样例 : 0

integer (int32)

platformIdEq
可选

平台id等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

3.98. 内容投放的位置

名称 说明 类型

channel
可选

渠道
样例 : "string"

string

code
可选

资源代码
样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

imageUrl
可选

图片Url
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

名称
样例 : "string"

string

orderNo
可选

序号
样例 : 0

integer (int32)

platformId
可选

平台id
样例 : "string"

string

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.99. 内容模板查询

名称 说明 类型

createGt
可选

模板创建时间起始于
样例 : "string"

string (date-time)

createLt
可选

模板创建时间截止于
样例 : "string"

string (date-time)

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyword
可选

关键字
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

placeIdEq
可选

内容资源位代码等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

updateGt
可选

模板更新时间起始于
样例 : "string"

string (date-time)

updateLt
可选

模板更新时间截止于
样例 : "string"

string (date-time)

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.100. 分类查询条件

名称 说明 类型

codeEq
可选

代码等于
样例 : "string"

string

codeIn
可选

代码在…范围内
样例 : [ "string" ]

< string > array

codeLike
可选

代码类似于
样例 : "string"

string

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyword
可选

代码名称类似于
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

nameLike
可选

名称类似于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

pathStartWidth
可选

路径开始于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

upperEq
可选

上级分类等于
样例 : "string"

string

upperIn
可选

上级分类在….范围内
样例 : [ "string" ]

< string > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.101. 区域

名称 说明 类型

points
可选

区域点位
样例 : [ "Point" ]

< Point > array

radius
可选

半径
样例 : 0.0

number

type
可选

区域类型, circle(圆形区域), polygon(多边形区域), lnglat(经纬度区域)
样例 : "string"

string

3.102. 品牌

名称 说明 类型

code
必填

品牌代码
样例 : "string"

string

id
必填

品牌id
样例 : "string"

string

name
必填

品牌名称
样例 : "string"

string

orgId
必填

组织id
样例 : "string"

string

orgType
必填

组织类型
样例 : "string"

string

path
可选

品牌路径
样例 : "string"

string

upper
可选

上级品牌
样例 : "string"

string

3.103. 品牌查询条件

名称 说明 类型

codeEq
可选

代码等于
样例 : "string"

string

codeStartWith
可选

代码起始于
样例 : "string"

string

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

nameLike
可选

名称类似于
样例 : "string"

string

orgIdEq
可选

所属组织ID等于
样例 : "string"

string

orgTypeEq
可选

所属组织类型等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

upperEq
可选

父品牌等于
样例 : "string"

string

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.104. 商品分类

名称 说明 类型

code
必填

样例 : "string"

string

id
必填

样例 : "string"

string

name
可选

分类名称
样例 : "string"

string

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

path
可选

分类路径
样例 : "string"

string

upper
可选

上级分类
样例 : "string"

string

3.105. 商品参数

名称 说明 类型

name
可选

名称
样例 : "string"

string

value
可选


样例 : "string"

string

3.106. 商品特性

名称 说明 类型

name
可选

名称
样例 : "string"

string

options
可选

可选值
样例 : [ "string" ]

< string > array

3.107. 商品销售属性

名称 说明 类型

name
可选

名称
样例 : "string"

string

value
可选


样例 : "string"

string

3.108. 地址

名称 说明 类型

cityId
可选

城市id
样例 : "string"

string

cityName
可选

城市名称
样例 : "string"

string

country
可选

国家
样例 : "string"

string

detailAddress
可选

详细地址
样例 : "string"

string

districtId
可选

地区id
样例 : "string"

string

districtName
可选

地区名称
样例 : "string"

string

latitude
可选

纬度
样例 : "string"

string

longitude
可选

经度
样例 : "string"

string

postcode
可选

邮编
样例 : "string"

string

provinceId
可选

省份id
样例 : "string"

string

provinceName
可选

身份名称
样例 : "string"

string

streetId
可选

街道id
样例 : "string"

string

streetName
可选

街道名称
样例 : "string"

string

3.109. 地址库

名称 说明 类型

childrens
可选

子级地址
样例 : [ "地址库" ]

< 地址库 > array

id
可选

id
样例 : "string"

string

level
可选

层级
样例 : 0

integer (int32)

name
可选

名称
样例 : "string"

string

pinyin
可选

拼音
样例 : "string"

string

upper
可选

上级
样例 : "string"

string

uuid
可选

样例 : "string"

string

3.110. 平台前台Sku

名称 说明 类型

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

frontSkuId
可选

前台SKU_ID
样例 : "string"

string

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

platformId
可选

平台ID
样例 : "string"

string

sku
可选

sku信息
样例 : "SKU"

SKU

frontSku
可选

前台SKU
样例 : [ "FrontSku" ]

FrontSku

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

freightTemplate
可选

运费模板id
样例 : "string"

string

3.111. 平台类目

名称 说明 类型

children
可选

子类目
样例 : [ "平台类目" ]

< 平台类目 > array

code
可选

代码
样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

image
可选

图片
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

名称
样例 : "string"

string

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

path
可选

路径
样例 : "string"

string

platformId
可选

平台id
样例 : "string"

string

sort
可选

排序值
样例 : 0

integer (int32)

tenant
可选

租户
样例 : "string"

string

type
可选

类型
样例 : "string"

string

upperId
可选

上级
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.112. 平台类目商品

名称 说明 类型

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

platformCategoryId
可选

平台类目id
样例 : "string"

string

platformCategoryType
可选

平台类目类型
样例 : "string"

string

platformId
可选

平台id
样例 : "string"

string

skuId
可选

商品SKUID
样例 : "string"

string

sort
可选

排序值
样例 : 0

integer (int32)

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

3.113. 平台类目商品查询条件

名称 说明 类型

fetchParts
可选

级联查询信息
样例 : "string"

string

orgIdEq
可选

组织id等于
样例 : "string"

string

orgTypeEq
可选

组织类型等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

platformCategoryIdEq
可选

平台类目id等于
样例 : "string"

string

platformCategoryIdIn
可选

平台类目id在之中
样例 : [ "string" ]

< string > array

platformCategoryTypeEq
可选

平台类目类型等于
样例 : "string"

string

platformCategoryTypeIn
可选

平台类目类型在之中
样例 : [ "string" ]

< string > array

platformIdEq
可选

平台id等于
样例 : "string"

string

platformIdIn
可选

平台id在之中
样例 : [ "string" ]

< string > array

skuIdIn
可选

商品SKUID在之中
样例 : [ "string" ]

< string > array

skuIdLike
可选

商品SKUID类似于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

3.114. 平台类目查询条件

名称 说明 类型

codeIn
可选

code在…范围内
样例 : [ "string" ]

< string > array

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

nameEq
可选

名称等于
样例 : "string"

string

nameIn
可选

名称在…范围内
样例 : [ "string" ]

< string > array

orgIdEq
可选

组织id等于
样例 : "string"

string

orgTypeEq
可选

组织类型等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

pathStartWith
可选

路径起始于
样例 : "string"

string

platformIdEq
可选

平台id等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

typeEq
可选

类型等于
样例 : "string"

string

upperIdEq
可选

上级类目等于
样例 : "string"

string

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.115. 平台门店

名称 说明 类型

associateShop
可选

关联门店
样例 : "门店"

门店

businessHour
可选

平台门店营业时间
样例 : [ "string" ]

< string > array

businessState
可选

平台门店营业状态
样例 : "string"

enum (normal, rest, closed)

code
可选

平台门店代码, 对应平台上的门店id
样例 : "string"

string

configs
可选

平台门店配置
样例 : { "string" : "string" }

< string, string > map

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

enabled
可选

是否启用
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

merchant
可选

平台商家
样例 : "IdName"

IdName

name
可选

平台门店名称
样例 : "string"

string

platform
可选

平台
样例 : "IdName"

IdName

state
可选

平台门店状态
样例 : "string"

enum (applying, opened, closed)

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.116. 平台门店分类查询条件

名称 说明 类型

codeEq
可选

代码等于
样例 : "string"

string

codeIn
可选

代码在…范围内
样例 : [ "string" ]

< string > array

fetchParts
可选

级联查询信息
样例 : "string"

string

hasSku
可选

样例 : true

boolean

idEq
可选

id等于
样例 : "string"

string

keyword
可选

代码名称类似于
样例 : "string"

string

upperEq
可选

上级分类等于
样例 : "string"

string

3.117. 平台门店商品

名称 说明 类型

attach
可选

附件信息
样例 : "平台门店商品附件信息"

平台门店商品附件信息

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

enabled
可选

是否上架
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

platform
可选

平台
样例 : "IdName"

IdName

saleStatus
可选

是否可售卖
样例 : true

boolean

shop
可选

门店
样例 : "IdName"

IdName

sku
可选

sku
样例 : "SKU"

SKU

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.118. 平台门店商品查询条件

名称 说明 类型

attachFilter
可选

附加信息查询条件
样例 : "平台门店商品附件信息查询条件"

平台门店商品附件信息查询条件

brandIdIn
可选

商品品牌ID在列表…
样例 : [ "string" ]

< string > array

brandIdNotIn
可选

商品品牌ID不在列表…
样例 : [ "string" ]

< string > array

categoryIdIn
可选

商品平台分类ID在列表…
样例 : [ "string" ]

< string > array

categoryIdNotIn
可选

商品平台分类ID不在在列表…
样例 : [ "string" ]

< string > array

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

enabledEq
可选

是否启用
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

平台门店商品ID在列表…
样例 : [ "string" ]

< string > array

keyword
可选

关键字等于,sku的名称/ID/条码/编码的模糊查询
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

platformCategoryIdEq
可选

平台分类id等于
样例 : "string"

string

platformCategoryIdIn
可选

平台分类id在..范围
样例 : [ "string" ]

< string > array

platformIdEq
可选

平台ID等于
样例 : "string"

string

priceRange
可选

商品价格范围
样例 : [ 0.0 ]

< number > array

shopCodeEq
可选

门店代码等于
样例 : "string"

string

shopIdEq
可选

门店ID等于
样例 : "string"

string

shopIdIn
可选

门店ID在列表…
样例 : [ "string" ]

< string > array

skuCodeEq
可选

样例 : "string"

string

skuFetchParts
可选

sku级联查询信息
样例 : "string"

string

skuIdIn
可选

商品skuID在列表…
样例 : [ "string" ]

< string > array

skuIdNotIn
可选

商品skuID不在列表…
样例 : [ "string" ]

< string > array

skuInputCodeCodeEq
可选

商品条码等于
样例 : "string"

string

skuInputCodeCodeIn
可选

商品条码在…范围
样例 : [ "string" ]

< string > array

skuSaleStatusEq
可选

商品可售状态等于
样例 : "string"

string

skuSpuIdEq
可选

商品spuID等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

upperPlatformCategoryIdEq
可选

平台分类id等于
样例 : "string"

string

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.119. 平台门店商品索引查询条件

名称 说明 类型

conditions
可选

查询条件,多个之间AND关系
样例 : [ "Condition" ]

< Condition > array

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序条件
样例 : [ "Sort" ]

< Sort > array

unionConditions
可选

联合查询条件,多个之间AND关系
样例 : [ "UnionCondition" ]

< UnionCondition > array

3.120. 平台门店商品附件信息

名称 说明 类型

fields
可选

数据
样例 : "object"

object

id
可选

id
样例 : "string"

string

3.121. 平台门店商品附件信息查询条件

名称 说明 类型

conditions
可选

查询条件,多个之间AND关系
样例 : [ "Condition" ]

< Condition > array

unionConditions
可选

联合查询条件,多个之间AND关系
样例 : [ "UnionCondition" ]

< UnionCondition > array

3.122. 平台门店查询条件

名称 说明 类型

businessStateEq
可选

营业状态等于
样例 : "string"

string

cityIdEq
可选

所属城市等于
样例 : "string"

string

codeEq
可选

平台门店代码等于
样例 : "string"

string

codeIdIn
可选

平台门店代码在….范围
样例 : [ "string" ]

< string > array

codeStartWith
可选

平台门店代码起始于
样例 : "string"

string

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

hasAssociateShop
可选

是否有关联门店
样例 : true

boolean

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyLike
可选

平台门店代码, 门店代码, 门店名称类似于
样例 : "string"

string

merchantCodeIn
可选

平台商家代码在什么范围内
样例 : [ "string" ]

< string > array

merchantCodeStartWith
可选

平台商家代码起始于
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

platformIdEq
可选

平台等于
样例 : "string"

string

shopCodeIn
可选

门店代码在..范围
样例 : [ "string" ]

< string > array

shopCodeStartWith
可选

门店代码起始于
样例 : "string"

string

shopIdEq
可选

门店Id等于
样例 : "string"

string

shopIdIn
可选

门店Id在..范围
样例 : [ "string" ]

< string > array

shopIdLike
可选

门店Id类似于
样例 : "string"

string

shopNameLike
可选

门店名称类似于
样例 : "string"

string

shopTypeEq
可选

门店类型等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

stateEq
可选

平台门店状态等于
样例 : "string"

enum (applying, opened, closed)

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.123. 平台门店类目

名称 说明 类型

children
可选

子类目
样例 : [ "平台门店类目" ]

< 平台门店类目 > array

code
可选

代码
样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

id
可选

平台类目id
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

名称
样例 : "string"

string

path
可选

路径
样例 : "string"

string

platformId
可选

平台id
样例 : "string"

string

shopId
可选

门店id
样例 : "string"

string

sort
可选

排序值
样例 : 0

integer (int32)

tenant
可选

租户
样例 : "string"

string

type
可选

平台类目类型
样例 : "string"

string

upperId
可选

上级
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.124. 排序规则

名称 说明 类型

createInfo
可选

样例 : "OperateInfo"

OperateInfo

dataKey
可选

数据主键
样例 : "string"

string

dataType
可选

排序数据类型
样例 : "string"

string

deleted
可选

已删除
样例 : true

boolean

id
可选

标识
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

platformId
可选

平台id
样例 : "string"

string

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.125. 排序规则查询条件

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

dataTypeEq
可选

数据类型等于
样例 : "string"

string

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

platformIdEq
可选

平台id等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.126. 数据归档

名称 说明 类型

businessKey
可选

业务主键
样例 : "string"

string

content
可选

数据内容
样例 : "object"

object

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

tenant
可选

租户
样例 : "string"

string

type
可选

类型
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.127. 数据归档查询条件

名称 说明 类型

bizKeyEq
可选

业务主键等于
样例 : "string"

string

bizKeyIn
可选

业务主键在..范围内
样例 : [ "string" ]

< string > array

bizKeyNotIn
可选

业务主键不在..范围内
样例 : [ "string" ]

< string > array

contentIn
可选

内容在什么范围
样例 : [ "SourceKV" ]

< SourceKV > array

contentLike
可选

内容匹配
样例 : [ "SourceKV" ]

< SourceKV > array

fetchParts
可选

级联查询信息
样例 : "string"

string

keywordEq
可选

关键字匹配
样例 : [ "SourceKV" ]

< SourceKV > array

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

typeEq
可选

类型等于
样例 : "string"

string

3.128. 文档

名称 说明 类型

fields
可选

文档数据
样例 : "object"

object

id
可选

文档id
样例 : "string"

string

index
可选

索引index
样例 : "string"

string

type
可选

索引type
样例 : "string"

string

3.129. 联系信息

名称 说明 类型

email
可选

联系人邮箱
样例 : "string"

string

fax
可选

联系人传真
样例 : "string"

string

mobile
可选

联系人手机
样例 : "string"

string

name
可选

联系人名称
样例 : "string"

string

telephone
可选

联系人电话
样例 : "string"

string

3.130. 角标

名称 说明 类型

code
可选

代码
样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

名称
样例 : "string"

string

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

purpose
可选

用途
样例 : "string"

string

template
可选

模版
样例 : "string"

string

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.131. 角标查询筛选条件

名称 说明 类型

codeIn
可选

code在…内
样例 : [ "string" ]

< string > array

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyword
可选

关键字等于,名称/code 的模糊查询
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

orgIdEq
可选

orgId等于
样例 : "string"

string

orgTypeEq
可选

orgType等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

purposeEq
可选

用途
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.132. 详情描述

名称 说明 类型

content
可选

内容
样例 : "string"

string

order
可选

排序
样例 : 0

integer (int32)

type
可选

类型
样例 : "string"

string

3.133. 输入码

名称 说明 类型

code
必填

代码
样例 : "string"

string

qpc
可选

规格
样例 : 0.0

number

qpcStr
可选

规格说明
样例 : "string"

string

type
必填

类型
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

weight
可选

重量
样例 : 0.0

number

3.134. 运费配置

名称 说明 类型

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

deliveryFee
可选

配送费
样例 : 0.0

number

freeSelfTake
可选

自提订单免起送价
样例 : true

boolean

id
可选

ID
样例 : "string"

string

incrByWeight
可选

开启重量费用计价
样例 : true

boolean

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

packFee
可选

打包费
样例 : 0.0

number

platformId
可选

平台id
样例 : "string"

string

regions
可选

配送区域
样例 : [ "区域" ]

< 区域 > array

startFee
可选

起送价
样例 : 0.0

number

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

weightFeeRule
可选

费用计价规则
样例 : "配送费重量规则"

配送费重量规则

3.135. 运费配置查询条件

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

orgIdEq
可选

样例 : "string"

string

orgIdIn
可选

样例 : [ "string" ]

< string > array

orgTypeEq
可选

样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.136. 选项

名称 说明 类型

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

key
必填

选项名
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

parameters
必填

参数
样例 : [ "Parameter" ]

< Parameter > array

tenant
可选

租户
样例 : "string"

string

type
必填

类型
样例 : "string"

string

uuid
可选

样例 : "string"

string

value
必填

选项值
样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.137. 配送方式

名称 说明 类型

bizKey
可选

业务主键
样例 : "string"

string

code
可选

代码
样例 : "string"

string

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

enabled
可选

是否启用
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

名称
样例 : "string"

string

orgId
可选

组织id
样例 : "string"

string

orgType
可选

组织类型
样例 : "string"

string

platformId
可选

平台id, 不区分平台则用-表示
样例 : "string"

string

tenant
可选

租户
样例 : "string"

string

type
可选

类型,shop/sku
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.138. 配送方式查询条件

名称 说明 类型

bizKeyEq
可选

业务主键等于
样例 : "string"

string

bizKeyIn
可选

业务主键等于
样例 : [ "string" ]

< string > array

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

orgIdEq
可选

组织id等于
样例 : "string"

string

orgTypeEq
可选

组织类型等于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

platformIdEq
可选

平台id等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

typeEq
可选

业务类型等于
样例 : "string"

string

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.139. 配送费重量规则

名称 说明 类型

base
可选

基础重量
样例 : 0.0

number

offset
可选

偏移重量,每增加多少重量
样例 : 0.0

number

offsetFee
可选

偏移价格,每增加多少重量,增加多少费用
样例 : 0.0

number

3.140. 门店

名称 说明 类型

address
可选

地址信息
样例 : "地址"

地址

businessCircles
可选

商圈
样例 : [ "string" ]

< string > array

businessHour
可选

营业时间
样例 : "string"

string

code
必填

代码
样例 : "string"

string

complainPhoneHour
可选

客诉服务时间
样例 : "string"

string

complainPhoneNumber
可选

客诉电话
样例 : "string"

string

configs
可选

门店配置
样例 : { "string" : "string" }

< string, string > map

contact
可选

联系信息
样例 : "联系信息"

联系信息

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

descriptions
可选

详情信息
样例 : [ "详情描述" ]

< 详情描述 > array

enabled
可选

启禁用
样例 : true

boolean

facadeImage
可选

店头照
样例 : "string"

string

id
可选

ID
样例 : "string"

string

image
可选

主图
样例 : "string"

string

images
可选

副图
样例 : [ "string" ]

< string > array

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

level
可选

等级
样例 : "string"

string

name
必填

名称
样例 : "string"

string

remaindPhoneNumber
可选

催单电话
样例 : "string"

string

servicePhoneNumber
可选

服务电话
样例 : "string"

string

tags
可选

标签
样例 : [ "Tag" ]

< Tag > array

tenant
可选

租户
样例 : "string"

string

type
必填

门店类型
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.141. 门店商品

名称 说明 类型

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

enabled
可选

是否上架
样例 : true

boolean

id
可选

ID
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

saleStatus
可选

是否可售卖
样例 : true

boolean

shop
可选

门店
样例 : "IdName"

IdName

sku
可选

商品
样例 : "SKU"

SKU

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)

3.142. 门店商品查询条件

名称 说明 类型

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyword
可选

关键字等于,sku的名称/ID/编码/条码 的模糊查询
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

shopIdEq
可选

shopIdEq等于
样例 : "string"

string

skuBusinessTypeEq
可选

经营方式等于
样例 : "string"

string

skuIdEq
可选

skuIdEq等于
样例 : "string"

string

skuIdIn
可选

skuId在…范围
样例 : [ "string" ]

< string > array

skuInputCodeCodeEq
可选

商品条码等于
样例 : "string"

string

skuInputCodeCodeIn
可选

商品条码等于
样例 : [ "string" ]

< string > array

skuSaleTypeEq
可选

sku销售方式等于
样例 : "string"

string

skuTypeEq
可选

sku类型等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

UUID在范围
样例 : [ "string" ]

< string > array

3.143. 门店查询条件

名称 说明 类型

addressLike
可选

地址类似于
样例 : "string"

string

businessCircleEq
可选

商圈等于
样例 : "string"

string

cityEq
可选

城市等于
样例 : "string"

string

cityIn
可选

城市在…范围内
样例 : [ "string" ]

< string > array

codeEq
可选

代码等于
样例 : "string"

string

codeIn
可选

代码在…范围内
样例 : [ "string" ]

< string > array

codeLike
可选

代码类似于
样例 : "string"

string

codeNotIn
可选

代码不在…范围内
样例 : [ "string" ]

< string > array

createdGt
可选

创建时间起始于
样例 : "string"

string (date-time)

createdLt
可选

创建时间截止于
样例 : "string"

string (date-time)

deletedEq
可选

是否已删除等于
样例 : true

boolean

enabledEq
可选

启禁用状态
样例 : true

boolean

fetchParts
可选

级联查询信息
样例 : "string"

string

idEq
可选

ID等于
样例 : "string"

string

idIn
可选

ID在…范围内
样例 : [ "string" ]

< string > array

keyword
可选

名称、代码类似于
样例 : "string"

string

levelEq
可选

门店等级等于
样例 : "string"

string

modifiedGt
可选

最后修改时间起始于
样例 : "string"

string (date-time)

modifiedLt
可选

最后修改时间截止于
样例 : "string"

string (date-time)

nameLike
可选

名称类似于
样例 : "string"

string

page
可选

页号
样例 : 0

integer (int32)

pageSize
可选

页记录数
样例 : 0

integer (int32)

platformEq
可选

对接平台等于
样例 : "string"

string

sorts
可选

排序字段集合
样例 : [ "Sort" ]

< Sort > array

typeEq
可选

门店类型等于
样例 : "string"

string

typeIn
可选

门店类型在…范围内
样例 : [ "string" ]

< string > array

uuidEq
可选

UUID等于
样例 : "string"

string

uuidIn
可选

uuid在…范围内
样例 : [ "string" ]

< string > array

3.144. 页面模板

名称 说明 类型

content
可选

内容
样例 : "object"

object

createInfo
可选

样例 : "OperateInfo"

OperateInfo

deleted
可选

已删除
样例 : true

boolean

id
可选

ID
样例 : "string"

string

image
可选

图片
样例 : "string"

string

lastModifyInfo
可选

样例 : "OperateInfo"

OperateInfo

name
可选

样例 : "string"

string

placeId
可选

资源位id
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

tenant
可选

租户
样例 : "string"

string

uuid
可选

样例 : "string"

string

version
可选

样例 : 0

integer (int64)

versionTime
可选

样例 : "string"

string (date-time)