(租户)主数据管理

总线配置

总线-终端修改

基本信息

Path： /terminalSave

Method： GET

接口描述：

页面终端新增，页面终端编辑，终端批量导入，终端批量覆盖更新，API终端新增，API终端编辑，API 终端批量新增
terminal-save-out-0:
destination:com.myfmes.terminal.terminalSave
binder:nats

发总线示例字段：
{
   "address": "辽宁省大连市甘井子区三丰大厦ue1997123",
   "area": "甘井子区",
   "areaCode": "210211",
   "baiduLat": 38.86783,
   "baiduLon": 121.522736,
   "channelCode": "STCH00X7DHZREMNF",
   "channelName": "购物/综合商场/百货商场",
   "city": "大连市",
   "cityCode": "210200",
   "createdAt": 1702868752529,
   "creater": "uTUzn0KBIC5iO7eqYP7fXY9bAWoxoV4R",
   "doorPhoto": "",
   "licenseAddress": "微店平台:https://weidian.com/s/1405572833",
   "licenseCode": "92330624MA2BGLK29T",
   "licenseDay": "2019年01月02日",
   "licenseExpiry": "无",
   "licenseName": "新昌县咖雀日用品商行",
   "licensePhoto": "terminal/20231218/uTUzn0KBIC5iO7eqYP7fXY9bAWoxoV4R_terminaldoor_50b3df8d2e9c4df9a9036336d3324640.jpg",
   "licenseScope": "网上销售:日用百货、服装、箱包、鞋帽、化妆品(仅限于通过互联网从事经营活动)(依法须经批准的项目,经相关部门批准后方可开展经营活动)",
   "licenseType": "个体工商户",
   "phone": "",
   "province": "辽宁省",
   "provinceCode": "210000",
   "scaleType": 1,
   "status": 1,
   "tenCode": "tCUzl0KB2AsgdKsAwc56EOQA",
   "terminalCode": "STT000R8T8B7U8N8L",
   "terminalExtraStr": "{}",
   "terminalName": "高新会友便利店",
   "terminalOriginCode": "A2",
   "terminalUCode": "STTU00R8V7W3JLR8L",
   "town": "凌水街道"
}

请求参数

返回数据

名称	类型	是否必须	备注
terminalName	string	非必须	租户终端名称
terminalCode	string	必须	租户终端编码
terminalUCode	string	必须	租户终端唯一编码
terminalOriginCode	string	非必须	来源
tenCode	string	必须	租户编码
channelCode	string	非必须	渠道编码
channelName	string	非必须	渠道名称，带出所有上级，用/拼接
baiduLon	string	非必须	经度
baiduLat	string	非必须	纬度
province	string	非必须	省
provinceCode	string	非必须	省编码
city	string	非必须	市
cityCode	string	非必须	市编码
area	string	非必须	区
areaCode	string	非必须	区编码
address	string	非必须	地址
doorPhoto	string	非必须	门头照，相对地址
scaleType	number	非必须	规模：1独立，2连锁
status	number	非必须	状态：1启用，0禁用
phone	string	非必须	联系电话，明文
terminalExtraStr	string	非必须	扩展字段字符串，如{\"terminal1\":\"600\"}，查看扩展字段进行解析
licenseAddress	string	非必须	经营场所
licenseCode	string	非必须	统一社会信用代码
licenseDay	string	非必须	注册日期
licenseExpiry	string	非必须	有效期
licenseName	string	非必须	经营者
licensePhoto	string	非必须	营业执照照片，相对地址
licenseScope	string	非必须	经营范围
licenseType	string	非必须	经营类型

总线-终端禁用

基本信息

Path： /terminalUpdatestatus

Method： GET

接口描述：

终端启用/禁用
terminal-updatestatus-out-0:
destination:com.myfmes.terminal.terminalUpdatestatus
binder:nats

发总线示例字段：
[
   {
      "code": "STT000TUFAMXDL9JJ8",
      "id": 198482,
      "status": 0,
      "tenCode": "tCUzl0KB2AsgdKsAwc56EOQA",
      "terminalUCode": "STTU00TU2TV7KVKJJ8"
   },
   {
      "code": "STT000TLS2H5X5SHJ8",
      "id": 198481,
      "status": 0,
      "tenCode": "tCUzl0KB2AsgdKsAwc56EOQA",
      "terminalUCode": "STTU00TLPZJVVHUHJ8"
   }
]

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

点位管理API

单条点位新增

基本信息

Path： /api/terminal/v1/pointPositionApi/add/pointPosition

Method： POST

接口描述：

{
    "pointName": "5",
    "pointArea": "干果",
    "pointMemo": "---",
    "terminalUCode": "STTU00KR2H9SEFD8",
    "tenCode": "test"
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
pointName	string	必须	点位名称
pointArea	string	非必须	点位区域
pointMemo	string	非必须	点位描述
terminalUCode	string	必须	和终端唯一编码必填一个
terminalCode	string	必须	和跨租户的终端全局唯一编码必填一个
tenCode	string	必须	租户code

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true成功，false失败
errorCode	string	非必须	错误码
errorMessage	string	非必须	错误信息提示
data	object	非必须	正确信息提示
├─ pointName	string	必须
├─ pointCode	string	必须
├─ pointArea	string	非必须
├─ pointMemo	string	非必须
├─ terminalCode	string	必须
├─ terminalUCode	string	必须
├─ tenCode	string	必须
traceId	string	非必须	请求唯一标识

多条点位新增

基本信息

Path： /api/terminal/v1/pointPositionApi/add/pointPositionList

Method： POST

接口描述：

[{
    "pointName": "5",
    "pointArea": "干果",
    "pointMemo": "---",
    "terminalUCode": "STTU00KR2H9SEFD8",
    "tenCode": "test"
},{
    "pointName": "6",
    "pointArea": "干果",
    "pointMemo": "---",
    "terminalUCode": "STTU00KR2H9SEFD8",
    "tenCode": "test"
}
]

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ pointName	string	必须	点位名称
├─ pointArea	string	非必须	点位区域
├─ pointMemo	string	非必须	点位描述
├─ terminalUCode	string	必须	和终端唯一编码必填一个
├─ terminalCode	string	必须	跨租户的终端全局唯一编码必填一个
├─ field_2	string	必须	租户code

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true成功，false失败
errorCode	string	非必须	错误码
errorMessage	string	非必须	错误信息提示
data	object	必须	正确信息提示
├─ pointName	string	必须
├─ pointCode	string	必须
├─ pointArea	string	非必须
├─ pointMemo	string	非必须
├─ terminalUCode	string	必须
├─ terminalCode	string	必须
├─ tenCode	string	必须
traceId	string	非必须	请求唯一标识

点位列表查询

基本信息

Path： /api/terminal/v1/pointPositionApi/list

Method： GET

接口描述：

{
"success": true,
"data": [
    {
      "id": 1,
      "pointCode": "STTP00993UBRTYP2",
      "pointName": "1",
      "pointArea": "干果",
      "pointMemo": "---",
      "terminalId": 1,
      "terminalUCode": "STTU00KR2H9SEFD8",
      "terminalCode": null,
      "status": 1,
      "tenCode": "test",
      "appCode": null,
      "creater": null,
      "updater": null,
      "createdAtStr": null,
      "createdAt": "2023-11-16T01:36:43.000+00:00",
      "updatedAtStr": null,
      "updatedAt": "2023-11-16T01:36:43.000+00:00",
      "deletedAtStr": null,
      "deletedAt": null,
      "version": 0
    },
    {
      "id": 2,
      "pointCode": "STTP009BF5YDMSP2",
      "pointName": "2",
      "pointArea": "干果",
      "pointMemo": "---",
      "terminalId": 1,
      "terminalUCode": "STTU00KR2H9SEFD8",
      "terminalCode": null,
      "status": 1,
      "tenCode": "test",
      "appCode": null,
      "creater": null,
      "updater": null,
      "createdAtStr": null,
      "createdAt": "2023-11-16T01:43:38.000+00:00",
      "updatedAtStr": null,
      "updatedAt": "2023-11-16T01:43:38.000+00:00",
      "deletedAtStr": null,
      "deletedAt": null,
      "version": 0
    }
],
"traceId": "18f6e74a29cf9d144a5bbb25bd8cfec8",
"total": 6
}

请求参数

Headers

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

Query

参数名称	是否必须	备注
tenCode	是	租户编码
pointName	否	点位名称
pointArea	否	点位区域
terminalUCode	否	跨租户终端的全局唯一编码
terminalCode	否	终端唯一编码
status	否	1：启用 0：禁用
page	是	页码
size	是	条数

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ pointName	string	必须	点位名称
├─ pointArea	string	非必须	点位区域
├─ pointMemo	string	非必须	点位描述
├─ terminalUCode	string	必须	和终端唯一编码必填一个
├─ terminalCode	string	必须	跨租户的终端全局唯一编码必填一个
├─ field_2	string	必须	租户code

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true成功，false失败
errorCode	string	非必须	错误码
errorMessage	string	非必须	错误信息提示
data	string	非必须	正确信息提示
traceId	string	非必须	请求唯一标识

点位更新

基本信息

Path： /api/terminal/v1/pointPositionApi/update/pointPosition

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
pointName	string	非必须	点位名称
pointArea	string	非必须	点位区域
pointMemo	string	非必须	点位描述
tenCode	string	必须	租户code
status	number	必须	1：启用 0：禁用
pointCode	string	必须	点位id和点位code必传一个

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true成功，false失败
errorCode	string	非必须	错误码
errorMessage	string	非必须	错误信息提示
data	string	非必须	正确信息提示
traceId	string	非必须	请求唯一标识

点位详情查询

基本信息

Path： /api/terminal/v1/pointPositionApi/getInfoByCode

Method： GET

接口描述：

{
"success": true,
"data": {
    "id": 1,
    "pointCode": "STTP00993UBRTYP2",
    "pointName": "2",
    "pointArea": "干果",
    "pointMemo": "---",
    "terminalId": 1,
    "terminalUCode": "STTU00KR2H9SEFD8",
    "terminalCode": null,
    "status": 1,
    "tenCode": "test",
    "appCode": null,
    "creater": null,
    "updater": null,
    "createdAtStr": null,
    "createdAt": "2023-11-16T01:36:43.000+00:00",
    "updatedAtStr": null,
    "updatedAt": "2023-11-16T08:42:26.000+00:00",
    "deletedAtStr": null,
    "deletedAt": null,
    "version": 8
},
"traceId": "3a6a78642bdca5faa4481d611c3b694e"
}

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
tenCode	是		租户编码
code	是		点位code

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ pointName	string	必须	点位名称
├─ pointArea	string	非必须	点位区域
├─ pointMemo	string	非必须	点位描述
├─ terminalUCode	string	必须	和终端唯一编码必填一个
├─ terminalCode	string	必须	跨租户的终端全局唯一编码必填一个
├─ field_2	string	必须	租户code

返回数据

名称	类型	是否必须	备注
success	boolean	必须	true成功，false失败
errorCode	string	非必须	错误码
errorMessage	string	非必须	错误信息提示
data	string	非必须	正确信息提示
traceId	string	非必须	请求唯一标识

渠道管理API

渠道下拉列表

基本信息

Path： /api/terminal/v1/channelApi/list

Method： GET

接口描述：

{
"success": true,
"data": [
    {
      "channelCode": "CHANNELXJXD4ZA27Q",
      "channelName": "dfaafd33",
      "channelParCode": "0",
      "level": 1,
      "sort": 0,
      "isHave": false
    },
    {
      "channelCode": "CHANNELXQF2M8JEYL6",
      "channelName": "sgfsdgsert",
      "channelParCode": "0",
      "level": 1,
      "sort": 1,
      "isHave": true
    },
    {
      "channelCode": "CHANNELFK3CFZP4YGR",
      "channelName": "non exe",
      "channelParCode": "0",
      "level": 1,
      "sort": 2,
      "isHave": false
    },
    {
      "channelCode": "whtext03",
      "channelName": "父渠道2",
      "channelParCode": "0",
      "level": 1,
      "sort": 3,
      "isHave": false
    },
    {
      "channelCode": "CHANNELXBC2V77BL6",
      "channelName": "342daf2",
      "channelParCode": "0",
      "level": 1,
      "sort": 4,
      "isHave": true
    },
    {
      "channelCode": "CHANNELFEABHD2K32N",
      "channelName": "父渠道save1",
      "channelParCode": "0",
      "level": 1,
      "sort": 5,
      "isHave": true
    },
    {
      "channelCode": "whtext01",
      "channelName": "父渠道0",
      "channelParCode": "0",
      "level": 1,
      "sort": 6,
      "isHave": true
    },
    {
      "channelCode": "whtext02",
      "channelName": "父渠道1test",
      "channelParCode": "0",
      "level": 1,
      "sort": 7,
      "isHave": false
    },
    {
      "channelCode": "CHANNELXRELTTRFB5",
      "channelName": "2222",
      "channelParCode": "0",
      "level": 1,
      "sort": 8,
      "isHave": false
    }
],
"traceId": "e85f6e53268751069cabbccc86696ee2"
}

请求参数

Query

参数名称	是否必须	示例	备注
parCode	是		顶级父code="0",
name	否

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	true/false
data	object []	非必须		item 类型: object
├─ channelCode	string	必须	渠道code
├─ channelName	string	必须	渠道名称
├─ channelParCode	string	必须	渠道父code 顶级0
├─ level	number	必须	层级 1是最顶级
├─ sort	number	必须	排序sort
├─ isHave	boolean	必须	true 有下一级 false 无下一级
traceId	string	非必须	日志id

渠道关系名

基本信息

Path： /api/terminal/v1/channelApi/relationName

Method： GET

接口描述：

"父渠道0/子渠道/子渠道2"

请求参数

Query

参数名称	是否必须	示例	备注
code	是		渠道code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	string	非必须		渠道关系名

渠道子查父

基本信息

Path： /api/terminal/v1/channelApi/listParent

Method： GET

接口描述：

{
"success": true,
"data": [
    {
      "channelCode": "whtext01",
      "channelParCode": "0",
      "channelName": "父渠道0",
      "level": 1
    },
    {
      "channelCode": "whtext1000",
      "channelParCode": "whtext01",
      "channelName": "子渠道",
      "level": 2
    },
    {
      "channelCode": "whtext999",
      "channelParCode": "whtext1000",
      "channelName": "子渠道2",
      "level": 3
    }
],
"traceId": "47088e0eecd8d68acea6cb6a62c95144"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是		渠道code

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	true/false
data	object []	非必须		item 类型: object
├─ channelCode	string	必须	渠道code
├─ channelParCode	string	必须	渠道父code
├─ channelName	string	必须	渠道名称
├─ level	number	必须	层级 1，2，3，4
traceId	string	非必须

渠道树查询

基本信息

Path： /api/terminal/v1/channelApi/listAll

Method： GET

接口描述：

{
"success": true,
"data": [
    {
      "channelCode": "whtext01",
      "channelParCode": "0",
      "channelName": "父渠道0",
      "level": 1,
      "children": [
        {
          "channelCode": "whtext1000",
          "channelParCode": "whtext01",
          "channelName": "子渠道",
          "level": 2,
          "children": [
            {
              "channelCode": "whtext999",
              "channelParCode": "whtext1000",
              "channelName": "子渠道2",
              "level": 3,
              "children": [
                {
                  "channelCode": "whtext998",
                  "channelParCode": "whtext999",
                  "channelName": "子渠道3",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELXH8K5TZSRL6",
                  "channelParCode": "whtext999",
                  "channelName": "dfa",
                  "level": 4,
                  "children": null
                }
              ]
            }
          ]
        },
        {
          "channelCode": "CHANNELXFWH5DHNS7Q",
          "channelParCode": "whtext01",
          "channelName": "子渠道test01",
          "level": 2,
          "children": []
        }
      ]
    },
    {
      "channelCode": "whtext02",
      "channelParCode": "0",
      "channelName": "父渠道1test",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "whtext03",
      "channelParCode": "0",
      "channelName": "父渠道2",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELFEABHD2K32N",
      "channelParCode": "0",
      "channelName": "父渠道save1",
      "level": 1,
      "children": [
        {
          "channelCode": "CHANNELXYFEFSMHJL6",
          "channelParCode": "CHANNELFEABHD2K32N",
          "channelName": "1",
          "level": 2,
          "children": []
        },
        {
          "channelCode": "CHANNELXHJXM2JZGR",
          "channelParCode": "CHANNELFEABHD2K32N",
          "channelName": "2",
          "level": 2,
          "children": []
        }
      ]
    },
    {
      "channelCode": "CHANNELXJXD4ZA27Q",
      "channelParCode": "0",
      "channelName": "dfaafd33f",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELXBC2V77BL6",
      "channelParCode": "0",
      "channelName": "342daf2",
      "level": 1,
      "children": [
        {
          "channelCode": "CHANNELF2G6C6SZDGR",
          "channelParCode": "CHANNELXBC2V77BL6",
          "channelName": "1122222",
          "level": 2,
          "children": [
            {
              "channelCode": "CHANNELFHMBT3UFWVR",
              "channelParCode": "CHANNELF2G6C6SZDGR",
              "channelName": "1",
              "level": 3,
              "children": []
            },
            {
              "channelCode": "CHANNELFHZ722XD3VR",
              "channelParCode": "CHANNELF2G6C6SZDGR",
              "channelName": "2",
              "level": 3,
              "children": []
            },
            {
              "channelCode": "CHANNELFRKT5JSYBVR",
              "channelParCode": "CHANNELF2G6C6SZDGR",
              "channelName": "4",
              "level": 3,
              "children": []
            },
            {
              "channelCode": "CHANNELFRMGTXRJQVR",
              "channelParCode": "CHANNELF2G6C6SZDGR",
              "channelName": "5",
              "level": 3,
              "children": []
            },
            {
              "channelCode": "CHANNELFRB56ZS5VVR",
              "channelParCode": "CHANNELF2G6C6SZDGR",
              "channelName": "6666",
              "level": 3,
              "children": [
                {
                  "channelCode": "CHANNELFZCUC57SMVR",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "222",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELFH77YX2TXVR",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "111",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELFRLS8UUTAVR",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "4",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELFRGQG4PPKVR",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "5555",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELF9NDEJAZEVR",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "333",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELFZCK9DWJ5",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "43534",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELFHRPKK6CU5",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "444",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELFHMF4QH965",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "555",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELFRVZFQ49A5",
                  "channelParCode": "CHANNELFRB56ZS5VVR",
                  "channelName": "666",
                  "level": 4,
                  "children": null
                }
              ]
            },
            {
              "channelCode": "CHANNELF98VZZBTBVR",
              "channelParCode": "CHANNELF2G6C6SZDGR",
              "channelName": "7",
              "level": 3,
              "children": []
            }
          ]
        },
        {
          "channelCode": "CHANNELFAX8XQS2QGR",
          "channelParCode": "CHANNELXBC2V77BL6",
          "channelName": "222",
          "level": 2,
          "children": []
        },
        {
          "channelCode": "CHANNELFD94B2C8VR",
          "channelParCode": "CHANNELXBC2V77BL6",
          "channelName": "333",
          "level": 2,
          "children": []
        },
        {
          "channelCode": "CHANNELFV3RL3XCNVR",
          "channelParCode": "CHANNELXBC2V77BL6",
          "channelName": "444",
          "level": 2,
          "children": []
        },
        {
          "channelCode": "CHANNELFDVH5J2C3VR",
          "channelParCode": "CHANNELXBC2V77BL6",
          "channelName": "555",
          "level": 2,
          "children": []
        },
        {
          "channelCode": "CHANNELFDHZXYQFNVR",
          "channelParCode": "CHANNELXBC2V77BL6",
          "channelName": "666777",
          "level": 2,
          "children": []
        }
      ]
    },
    {
      "channelCode": "CHANNELXQF2M8JEYL6",
      "channelParCode": "0",
      "channelName": "sgfsdgsert",
      "level": 1,
      "children": [
        {
          "channelCode": "CHANNELXGSDC95FFL6",
          "channelParCode": "CHANNELXQF2M8JEYL6",
          "channelName": "123",
          "level": 2,
          "children": [
            {
              "channelCode": "CHANNELXLR57E8X8L6",
              "channelParCode": "CHANNELXGSDC95FFL6",
              "channelName": "1",
              "level": 3,
              "children": [
                {
                  "channelCode": "CHANNELXU3ABKXGKL6",
                  "channelParCode": "CHANNELXLR57E8X8L6",
                  "channelName": "234123",
                  "level": 4,
                  "children": null
                },
                {
                  "channelCode": "CHANNELX4RXKGUQNL6",
                  "channelParCode": "CHANNELXLR57E8X8L6",
                  "channelName": "213123",
                  "level": 4,
                  "children": null
                }
              ]
            },
            {
              "channelCode": "CHANNELXC9PUZ94YL6",
              "channelParCode": "CHANNELXGSDC95FFL6",
              "channelName": "1231123",
              "level": 3,
              "children": []
            },
            {
              "channelCode": "CHANNELXAC6H5LA8L6",
              "channelParCode": "CHANNELXGSDC95FFL6",
              "channelName": "123131",
              "level": 3,
              "children": []
            }
          ]
        },
        {
          "channelCode": "CHANNELXG2C7MSBPL6",
          "channelParCode": "CHANNELXQF2M8JEYL6",
          "channelName": "145",
          "level": 2,
          "children": []
        },
        {
          "channelCode": "CHANNELXQ5AM384SL6",
          "channelParCode": "CHANNELXQF2M8JEYL6",
          "channelName": "12213131241231",
          "level": 2,
          "children": []
        }
      ]
    },
    {
      "channelCode": "CHANNELXMA3XCT7TGR",
      "channelParCode": "0",
      "channelName": "5555",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELFK3CFZP4YGR",
      "channelParCode": "0",
      "channelName": "non exe",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELFLY9UHXPG5",
      "channelParCode": "0",
      "channelName": "1",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELFLUL8MTGU5",
      "channelParCode": "0",
      "channelName": "1111111111",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELF9976PCS65",
      "channelParCode": "0",
      "channelName": "22222222222222",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELXRELTTRFB5",
      "channelParCode": "0",
      "channelName": "2222",
      "level": 1,
      "children": []
    },
    {
      "channelCode": "CHANNELXBA9PSPLN5",
      "channelParCode": "0",
      "channelName": "test0012",
      "level": 1,
      "children": []
    }
],
"traceId": "26075cee08b123616ef57fb3fe95c9d5"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	否		渠道code 输入code 表示当前code下的渠道树，不输入代表完整渠道树

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	success/false
data	object []	非必须		item 类型: object
├─ channelCode	string	必须	渠道code
├─ channelParCode	string	必须	渠道父code
├─ channelName	string	必须	渠道名称
├─ level	number	必须	渠道层级 1，2，3，4
├─ children	object []	必须	子渠道	item 类型: object
├─ channelCode	string	必须
├─ channelParCode	string	必须
├─ channelName	string	必须
├─ level	number	必须
├─ children	object []	必须		item 类型: object
├─ channelCode	string	必须
├─ channelParCode	string	必须
├─ channelName	string	必须
├─ level	number	必须
├─ children	object []	必须		item 类型: object
├─ channelCode	string	必须
├─ channelParCode	string	必须
├─ channelName	string	必须
├─ level	number	必须
├─ children	string []	必须		item 类型: string
├─		非必须
traceId	string	非必须

品类管理API

品类下拉列表(查询子品类)

基本信息

Path： /api/singleproduct/v1/categoryApi/listSub

Method： GET

接口描述：

{

    "success":true,
    "data":[
        {
            "categoryName":"6",
            "categoryCode":"STC000FA5K4NSVCTZ7",
            "categoryParCode":null,
            "sort":1000,
            "isHave":true
        },
        {
            "categoryName":"5",
            "categoryCode":"STC000X6DKKLAX8Z7",
            "categoryParCode":null,
            "sort":999,
            "isHave":false
        },
        {
            "categoryName":"2",
            "categoryCode":"STC000XWPMGBMZCZ7",
            "categoryParCode":null,
            "sort":998,
            "isHave":false
        },
        {
            "categoryName":"4",
            "categoryCode":"STC000X6M8A3WW5Z7",
            "categoryParCode":null,
            "sort":997,
            "isHave":false
        },
        {
            "categoryName":"1",
            "categoryCode":"STC000XWGNHMTHAZ7",
            "categoryParCode":null,
            "sort":996,
            "isHave":true
        },
        {
            "categoryName":"3",
            "categoryCode":"STC000X6XLUGNMSZ7",
            "categoryParCode":null,
            "sort":995,
            "isHave":false
        }
    ],
    "traceId":"2202294a887b062f47884896aedb50a8"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是		品类code 不填查询顶级品类列表

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须	true/false
data	object []	非必须		item 类型: object
├─ categoryName	string	必须	品类名称
├─ categoryCode	string	必须	品类code
├─ categoryParCode	null	必须	品类父code
├─ sort	number	必须	排序值
├─ isHave	boolean	必须	true 有下一级 false无下一级
traceId	string	非必须	日志id

根据子品类code 获取品类层级关系名称

基本信息

Path： /api/singleproduct/v1/categoryApi/getCategoryRelation

Method： GET

接口描述：

简要描述

根据子品类code查找品类关系

请求URL

{{xxx-url}}/api/singleproduct/v1/categoryApi/getCategoryRelation?code=categoryTS23BNT3UQU
GET

参数

参数名	必选	类型	长度	说明
code	是	String	是	品类code

响应示例

{
    "errCode": null,
    "errMessage": null,
    "data": "个性化妆/身体护理",
    "success": true
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是		子品类code

返回数据

名称	类型	是否必须	备注
errCode	string	非必须
errMessage	string	非必须
data	string	非必须	当前子品类到当前1级品类
success	boolean	非必须

获取品类树

基本信息

Path： /api/singleproduct/v1/categoryApi/listAll

Method： GET

接口描述：

{
    "success": true,
    "data": [
      {
        "categoryCode": "STC000FQGJQPX3KB",
        "categoryParCode": null,
        "categoryName": "饮品",
        "deep": 1,
        "children": [
          {
            "categoryCode": "STC000FQQPXWY6PKB",
            "categoryParCode": "STC000FQGJQPX3KB",
            "categoryName": "婴幼儿饮品",
            "deep": 2,
            "children": [
              {
                "categoryCode": "STC000FQYU662AYKB",
                "categoryParCode": "STC000FQQPXWY6PKB",
                "categoryName": "奶粉",
                "deep": 3,
                "children": [
                  {
                    "categoryCode": "STC000FQCCQP6AAKB",
                    "categoryParCode": "STC000FQYU662AYKB",
                    "categoryName": "全脂奶粉",
                    "deep": 4,
                    "children": []
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "traceId": "218cf98220acae0836cfb691337ac181"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	否		不输入获取完整品类树，输入code 获取当前品类以及下级品类树

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ categoryCode	string	必须	品类code
├─ categoryParCode	null	必须	品类父code
├─ categoryName	string	必须	品类名称
├─ deep	number	必须	层级 1 2 3 4 5
├─ children	object []	必须		item 类型: object
├─ categoryCode	string	必须
├─ categoryParCode	string	必须
├─ categoryName	string	必须
├─ deep	number	必须
├─ children	object []	必须		item 类型: object
├─ categoryCode	string	必须
├─ categoryParCode	string	必须
├─ categoryName	string	必须
├─ deep	number	必须
├─ children	object []	必须		item 类型: object
├─ categoryCode	string	必须
├─ categoryParCode	string	必须
├─ categoryName	string	必须
├─ deep	number	必须
├─ children	object []	必须		item 类型: object
├─ categoryCode	string	必须
├─ categoryParCode	string	必须
├─ categoryName	string	必须
├─ deep	number	必须
├─ children	string []	必须		item 类型: string
├─		非必须
traceId	string	非必须

获取品类详情

基本信息

Path： /api/singleproduct/v1/categoryApi/get

Method： GET

接口描述：

简要描述

获取品类详情

请求URL

{{xxx-url}}/api/singleproduct/v1/categoryApi/get?code=11
GET

参数

参数名	必选	类型	长度	说明
code	是	String	50	品类code

响应示例当品牌code无值

{
    "success": true,
    "data": {
        "version": 7,
        "status": 1,
        "creater": "1",
        "updater": "1",
        "createdAt": "2022-01-27T07:54:41.000+00:00",
        "updatedAt": "2022-02-08T06:22:44.000+00:00",
        "deletedAt": null,
        "tenCode": "tC34r7ABy51h8iyQuIErrdko",
        "appCode": null,
        "id": 596,
        "categoryCode": "STC0007JGXC7U9P3",
        "categoryParCode": null,
        "categoryName": "123",
        "sort": 993,
        "isUse": null
    },
    "traceId": "6748f19cdef5d456ae03897a802bb062"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是		String 长度50 品类code

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ version	integer	非必须	版本号
├─ status	integer	非必须	数据状态 1:启用 0:禁用 2: 未激活 3: 注销 4: 删除
├─ creater	string	非必须	创建者
├─ updater	string	非必须	更新者
├─ createdAt	string	非必须	创建时间
├─ updatedAt	string	非必须	更新时间
├─ deletedAt	string	非必须	删除时间
├─ tenCode	string	非必须	租户code
├─ appCode	string	非必须	应用code
├─ id	integer	非必须	主键id
├─ categoryCode	string	非必须	品类code
├─ categoryParCode	string	非必须	品类父code
├─ categoryName	string	非必须	品类名称
├─ sort	integer	非必须	排序
├─ isUse	integer	非必须	是否被使用 0未被 1使用过
traceId	string	非必须

获取当前品类父品类

基本信息

Path： /api/singleproduct/v1/categoryApi/listParent

Method： GET

接口描述：

{
"success": true,
"data": [
    {
      "categoryName": "一级品类测试1",
      "categoryCode": "STC000PDRJWDZNL49",
      "categoryParCode": null,
      "deep": 1
    },
    {
      "categoryName": "二级品类测试1",
      "categoryCode": "STC000PD7KR5FBR49",
      "categoryParCode": "STC000PDRJWDZNL49",
      "deep": 2
    },
    {
      "categoryName": "三级品类测试1",
      "categoryCode": "STC000PDTNXBS5549",
      "categoryParCode": "STC000PD7KR5FBR49",
      "deep": 3
    },
    {
      "categoryName": "四级品类测试1",
      "categoryCode": "STC000PDFS5J5YG49",
      "categoryParCode": "STC000PDTNXBS5549",
      "deep": 4
    },
    {
      "categoryName": "五级品类测试1",
      "categoryCode": "STC000PDM6CMCSK49",
      "categoryParCode": "STC000PDFS5J5YG49",
      "deep": 5
    }
],
"traceId": "7c1a7e9970c4060b660c0b6ef371f9dd"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是		品类code

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ categoryName	string	必须	品类名称
├─ categoryCode	string	必须	品类code
├─ categoryParCode	null,string	必须	品类父code
├─ deep	number	必须	层级 1 2 3 4 5
traceId	string	非必须

品牌管理API

删除品牌

基本信息

Path： /api/singleproduct/v1/brandApi/updateStatus

Method： POST

接口描述：

简要描述

删除品牌

请求URL

{{xxx-url}}/api/singleproduct/v1/brandApi/updateStatus?code=singleproductBAMCLCYRVU
POST

参数

参数名	必选	类型	长度	说明
code	是	String	50	品牌code

响应示例

{
    "errCode": null,
    "errMessage": null,
    "success": true
}

请求参数

Query

参数名称	是否必须	示例	备注
code	否

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息

品牌下拉列表

基本信息

Path： /api/singleproduct/v1/brandApi/listSub

Method： GET

接口描述：

简要描述

品牌下拉列表

请求URL

{{xxx-url}}/api/singleproduct/v1/brandApi/listSub?code=11
GET

参数

参数名	必选	类型	长度	说明
code	否	String	50	品牌code不输入-查顶级品牌列表，输入品牌code-查当前品牌的子品牌列表

响应示例当品牌code无值

{
    "errCode": null,
    "errMessage": null,
    "total": 0,
    "data": [
        {
            "brandCode": "44",
            "brandParCode": null,
            "brandName": "丹东品牌",
            "imgLogo": null
        },
        {
            "brandCode": "10",
            "brandParCode": null,
            "brandName": "大连品牌",
            "imgLogo": null
        },
        {
            "brandCode": "singleproductB28LCWMJVU",
            "brandParCode": null,
            "brandName": "锦州品牌",
            "imgLogo": null
        },
        {
            "brandCode": "1005",
            "brandParCode": null,
            "brandName": "test品牌5",
            "imgLogo": null
        },
        {
            "brandCode": "1004",
            "brandParCode": null,
            "brandName": "test品牌4",
            "imgLogo": null
        },
        {
            "brandCode": "1003",
            "brandParCode": null,
            "brandName": "test品牌3",
            "imgLogo": null
        },
        {
            "brandCode": "1002",
            "brandParCode": null,
            "brandName": "test品牌3",
            "imgLogo": null
        },
        {
            "brandCode": "1001",
            "brandParCode": null,
            "brandName": "test品牌2",
            "imgLogo": null
        },
        {
            "brandCode": "1006",
            "brandParCode": null,
            "brandName": "test品牌6",
            "imgLogo": null
        },
        {
            "brandCode": "11",
            "brandParCode": null,
            "brandName": "沈阳品牌",
            "imgLogo": null
        },
        {
            "brandCode": "1000",
            "brandParCode": null,
            "brandName": "test品牌1",
            "imgLogo": null
        },
        {
            "brandCode": "1007",
            "brandParCode": null,
            "brandName": "test品牌7",
            "imgLogo": null
        },
        {
            "brandCode": "1012",
            "brandParCode": null,
            "brandName": "test品牌12",
            "imgLogo": null
        },
        {
            "brandCode": "1011",
            "brandParCode": null,
            "brandName": "test品牌11",
            "imgLogo": null
        },
        {
            "brandCode": "1010",
            "brandParCode": null,
            "brandName": "test品牌10",
            "imgLogo": null
        },
        {
            "brandCode": "1009",
            "brandParCode": null,
            "brandName": "test品牌9",
            "imgLogo": null
        },
        {
            "brandCode": "1008",
            "brandParCode": null,
            "brandName": "test品牌8",
            "imgLogo": null
        }
    ],
    "success": true
}

响应示例2 当品牌code有值

{
    "errCode": null,
    "errMessage": null,
    "total": 0,
    "data": [
        {
            "brandCode": "19",
            "brandParCode": "11",
            "brandName": "铁西区品牌",
            "imgLogo": null
        },
        {
            "brandCode": "singleproductBAMCLCYRVU",
            "brandParCode": "11",
            "brandName": "于洪区品牌",
            "imgLogo": null
        }
    ],
    "success": true
}

请求参数

Query

参数名称	是否必须	示例	备注
code	否

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须
errMessage	string	非必须
total	integer	非必须
data	object []	非必须		item 类型: object
├─ brandCode	string	必须	品牌code
├─ brandParCode	string	必须	品牌父code
├─ brandName	string	必须	品牌名称
├─ imgLogo	string	必须	图片url 绝对路径
success	boolean	非必须

新增品牌

基本信息

Path： /api/singleproduct/v1/brandApi/add

Method： POST

接口描述：

简要描述

新增品牌

请求URL

{{xxx-url}}/api/singleproduct/v1/brandApi/add
POST

参数

参数名	必选	类型	长度	说明
brandParCode	否	String	50	品牌的父code
brandName	是	String	255	品牌名称
imgLogo	否	String	255	品牌logo
memo	否	String	255	品牌描述
sort	否	Integer	4	排序默认为1

请求示例

{
    "brandParCode":"",
    "brandName":"康师傅",
    "imgLogo":"",
    "memo":"",
    "sort":"1"
}

响应示例

{
    "errCode": null,
    "errMessage": null,
    "success": true
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
brandParCode	string	非必须	品牌的父code
brandName	string	非必须	品牌名称
imgLogo	string	非必须	品牌logo
memo	string	非必须	品牌描述
sort	string	非必须	排序默认为1

返回数据

名称	类型	是否必须	备注
errCode	null	非必须	错误码
errMessage	null	非必须	错误信息
success	boolean	必须	状态
traceId	string	必须	请求标识

查询品牌树

基本信息

Path： /api/singleproduct/v1/brandApi/listAll

Method： GET

接口描述：

功能描述

查询所有品牌，返回树形结构

响应示例

{
    "success":true,
    "data":[
        {
            "brandCode":"singleproduct3YU9M2ZW3SN",
            "brandParCode":"",
            "brandName":"喜之郎",
            "deep":1,
            "children":[
                {
                    "brandCode":"singleproduct32JQG3P5UD",
                    "brandParCode":"singleproduct3YU9M2ZW3SN",
                    "brandName":"喜见",
                    "deep":2,
                    "children":[
                        {
                            "brandCode":"singleproduct3LD2N46WX",
                            "brandParCode":"singleproduct32JQG3P5UD",
                            "brandName":"喜见33",
                            "deep":3,
                            "children":[
                                {
                                    "brandCode":"STB000XYAQ7B23JZ",
                                    "brandParCode":"singleproduct3LD2N46WX",
                                    "brandName":"测试分类23测试分类23测试分类2测试分类23测试分类23测试分类23",
                                    "deep":4,
                                    "children":[

]
                                }
                            ]
                        }
                    ]
                },
                {
                    "brandCode":"singleproduct3ARMU94KZD",
                    "brandParCode":"singleproduct3YU9M2ZW3SN",
                    "brandName":"喜之莲1",
                    "deep":2,
                    "children":[

]
                }
            ]
        }
    ],
    "traceId":"a5933c492605603427a5bdf37c275e0a"
}

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ brandCode	string	必须	品牌code
├─ brandParCode	string,null	必须	品牌父code
├─ brandName	string	必须	品牌名称
├─ deep	integer	必须	层级 1是父级依次递增子级2，3，4
├─ children	object []	必须		item 类型: object
├─ brandCode	string	必须
├─ brandParCode	string	必须
├─ brandName	string	必须
├─ deep	number	必须
├─ children	object []	必须		item 类型: object
├─ brandCode	string	必须
├─ brandParCode	string	必须
├─ brandName	string	必须
├─ deep	number	必须
├─ children	object []	必须		item 类型: object
├─ brandCode	string	必须
├─ brandParCode	string	必须
├─ brandName	string	必须
├─ deep	number	必须
├─ children	string []	必须		item 类型: string
├─		非必须
traceId	string	非必须

根据子品牌查品牌关系

基本信息

Path： /api/singleproduct/v1/brandApi/getBrandRelation

Method： GET

接口描述：

简要描述

根据子品牌查品牌关系

请求URL

{{xxx-url}}/api/singleproduct/v1/brandApi/getBrandRelation?code=1
GET

参数

参数名	必选	长度	类型	说明
code	是	50	String	品牌code

响应示例

{
    "errCode": null,
    "errMessage": null,
    "data": "大连品牌/甘井子品牌/高新园区品牌",
    "success": true
}

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
code	是
tenCode	否

返回数据

名称	类型	是否必须	备注
errCode	string	非必须
errMessage	string	非必须
data	string	非必须	当前子品类到一级品类
success	boolean	非必须

根据子品牌查询父品牌编码和名称

基本信息

Path： /api/singleproduct/v1/brandApi/listParent

Method： GET

接口描述：

<span class="colour" style="color: rgb(74, 85, 96);">{</span>

    "success":true,
    "data":[
        {
            "brandName":"     解决一切问题的总钥匙。中央关于党的百年奋斗重大成就和历史经验的决议》强调，必须实现",
            "brandCode":"singleproductF5TQ6SZET2K",
            "brandParCode":"",
            "deep":1
        },
        {
            "brandName":".3",
            "brandCode":"singleproductXAT3UWMWP2K",
            "brandParCode":"singleproductF5TQ6SZET2K",
            "deep":2
        }
    ],
    "traceId":"e9d83b84d5f1e966f86d196c3ac6236e"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是	singleproductXAT3UWMWP2K	品牌code

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ brandCode	string	必须	品牌code
├─ brandParCode	string	必须	父品牌code
├─ brandName	string	必须	品牌名称
├─ deep	integer	必须	层级 1是父级依次类推2，3，4
traceId	string	非必须

编辑品牌列表

基本信息

Path： /api/singleproduct/v1/brandApi/update

Method： POST

接口描述：

简要描述

编辑品牌

请求URL

{{xxx-url}}/api/singleproduct/v1/brandApi/update
POST

参数

参数名	必选	类型	长度	说明
brandCode	是	String	50	品牌code
brandParCode	否	String	50	品牌的父code
brandName	是	String	255	品牌名称
imgLogo	否	String	255	品牌logo
memo	否	String	255	品牌描述
sort	否	Integer	4	排序默认为1

请求示例

{
    "brandCode":"singleproductB28LCWMJVU",
    "brandParCode":"",
    "brandName":"锦州品牌",
    "imgLogo":"",
    "memo":"",
    "sort":"2"
}

响应示例

{
    "errCode": null,
    "errMessage": null,
    "total": 18,
    "data": [
        {
            "brandCode": "44",
            "brandParCode": null,
            "brandName": "丹东品牌",
            "imgLogo": null,
            "memo": null,
            "sort": 4,
            "createAt": "2021-10-13T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "10",
            "brandParCode": null,
            "brandName": "大连品牌",
            "imgLogo": null,
            "memo": null,
            "sort": 4,
            "createAt": "2021-10-13T09:11:02.000+00:00",
            "childBrandList": [
                {
                    "brandCode": "99",
                    "brandParCode": "10",
                    "brandName": "甘井子品牌",
                    "imgLogo": null,
                    "memo": null,
                    "sort": 1,
                    "createAt": "2021-10-13T09:11:09.000+00:00",
                    "childBrandList": [
                        {
                            "brandCode": "12",
                            "brandParCode": "99",
                            "brandName": "高新园区品牌",
                            "imgLogo": null,
                            "memo": null,
                            "sort": 3,
                            "createAt": "2021-10-13T09:11:13.000+00:00",
                            "childBrandList": []
                        }
                    ]
                },
                {
                    "brandCode": "653",
                    "brandParCode": "10",
                    "brandName": "中山区品牌",
                    "imgLogo": null,
                    "memo": null,
                    "sort": 1,
                    "createAt": null,
                    "childBrandList": []
                }
            ]
        },
        {
            "brandCode": "singleproductB28LCWMJVU",
            "brandParCode": null,
            "brandName": "锦州品牌",
            "imgLogo": null,
            "memo": null,
            "sort": 2,
            "createAt": "2021-10-19T02:56:44.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "singleproductBFREVHKVKVU",
            "brandParCode": null,
            "brandName": "康师傅",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-19T07:01:58.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1005",
            "brandParCode": null,
            "brandName": "test品牌5",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-18T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1004",
            "brandParCode": null,
            "brandName": "test品牌4",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-17T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1003",
            "brandParCode": null,
            "brandName": "test品牌3",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-16T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1002",
            "brandParCode": null,
            "brandName": "test品牌3",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-15T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1001",
            "brandParCode": null,
            "brandName": "test品牌2",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-14T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1006",
            "brandParCode": null,
            "brandName": "test品牌6",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-13T10:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "11",
            "brandParCode": null,
            "brandName": "沈阳品牌",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-13T09:11:16.000+00:00",
            "childBrandList": [
                {
                    "brandCode": "19",
                    "brandParCode": "11",
                    "brandName": "铁西区品牌",
                    "imgLogo": null,
                    "memo": "1111",
                    "sort": 4,
                    "createAt": "2021-10-13T09:11:05.000+00:00",
                    "childBrandList": [
                        {
                            "brandCode": "singleproductB36HAU5ZVU",
                            "brandParCode": "19",
                            "brandName": "万达品牌",
                            "imgLogo": null,
                            "memo": null,
                            "sort": 1,
                            "createAt": "2021-10-19T02:13:05.000+00:00",
                            "childBrandList": []
                        }
                    ]
                },
                {
                    "brandCode": "singleproductBAMCLCYRVU",
                    "brandParCode": "11",
                    "brandName": "于洪区品牌",
                    "imgLogo": null,
                    "memo": null,
                    "sort": 1,
                    "createAt": "2021-10-19T03:09:06.000+00:00",
                    "childBrandList": []
                }
            ]
        },
        {
            "brandCode": "1000",
            "brandParCode": null,
            "brandName": "test品牌1",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-13T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1007",
            "brandParCode": null,
            "brandName": "test品牌7",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-13T03:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1012",
            "brandParCode": null,
            "brandName": "test品牌12",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-12T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1011",
            "brandParCode": null,
            "brandName": "test品牌11",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-11T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1010",
            "brandParCode": null,
            "brandName": "test品牌10",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-10T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1009",
            "brandParCode": null,
            "brandName": "test品牌9",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-08T09:11:03.000+00:00",
            "childBrandList": []
        },
        {
            "brandCode": "1008",
            "brandParCode": null,
            "brandName": "test品牌8",
            "imgLogo": null,
            "memo": null,
            "sort": 1,
            "createAt": "2021-10-07T09:11:03.000+00:00",
            "childBrandList": []
        }
    ],
    "success": true
}

请求参数

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须
errMessage	string	非必须
total	integer	非必须
data	object []	非必须		item 类型: object
├─ brandCode	string	必须	品牌code
├─ brandParCode	string	必须	品牌父code
├─ brandName	string	必须	品牌名称
├─ imgLogo	string	必须	图片url
├─ memo	string	必须	描述
├─ sort	integer	必须	排序
├─ createAt	string	必须	创建时间
├─ childBrandList	object []	必须	子品牌列表	item 类型: object
├─ brandCode	string	必须
├─ brandParCode	string	必须
├─ brandName	string	必须
├─ imgLogo	string	必须
├─ memo	null,string	必须
├─ sort	integer	必须
├─ createAt	string,null	必须
├─ childBrandList	object []	必须		item 类型: object
├─ brandCode	string	必须
├─ brandParCode	string	必须
├─ brandName	string	必须
├─ imgLogo	null	必须
├─ memo	null	必须
├─ sort	number	必须
├─ createAt	string	必须
├─ childBrandList	string []	必须		item 类型: string
├─		非必须
success	boolean	非必须

获取品牌详情

基本信息

Path： /api/singleproduct/v1/brandApi/get

Method： GET

接口描述：

简要描述

获取品牌详情

请求URL

{{xxx-url}}/api/singleproduct/v1/brandApi/get?code=11
GET

参数

参数名	必选	类型	长度	说明
code	是	String	50	品牌code

响应示例当品牌code无值

{
    "success": true,
    "data": {
        "version": 0,
        "status": 1,
        "creater": "1",
        "updater": "1",
        "createdAt": "2022-01-14T08:17:11.000+00:00",
        "updatedAt": "2022-01-14T08:17:11.000+00:00",
        "deletedAt": null,
        "tenCode": "tC34r7ABy51h8iyQuIErrdko",
        "appCode": null,
        "id": 223,
        "brandCode": "brandFTG2TVS4JLL",
        "brandParCode": null,
        "brandName": "蓝月亮",
        "imgLogo": null,
        "memo": null,
        "sort": 990,
        "isUse": 1
    },
    "traceId": "8e5849bc5a5c8de99d453a1154eb097e"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是		品牌code

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ version	number	非必须	版本号
├─ status	number	非必须	数据状态 1:启用 0:禁用 2: 未激活 3: 注销 4: 删除
├─ creater	string	非必须	创建人
├─ updater	string	非必须	更新人
├─ createdAt	string	非必须	创建时间
├─ updatedAt	string	非必须	更新时间
├─ deletedAt	string	非必须	删除时间
├─ tenCode	string	非必须	租户code
├─ appCode	string	非必须	应用code
├─ id	number	非必须	品牌id
├─ brandCode	string	非必须	品牌code
├─ brandParCode	string	非必须	品牌父code
├─ brandName	string	非必须
├─ imgLogo	string	非必须
├─ memo	string	非必须
├─ sort	number	非必须
├─ isUse	number	非必须
traceId	string	非必须

单品管理API

单品列表

基本信息

Path： /api/singleproduct/v1/productApi/list

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
spName	string	非必须	单品名称
spCode	string	非必须	单品编码
spBarCode	string	非必须	单品条码
categoryCode	string	非必须	品类编码
brandCode	string	非必须	品牌编码
status	integer	非必须	数据状态(0:禁用 1:启用)	枚举: 0,1
pageSize	integer	必须	每页显示条数(选填选填10、20、50或100)	枚举: 10,20,50,100
pageNum	integer	必须	当前页数(正整数)	最小值: 1
spNameOrSpCodeOrSpBarCode	string	非必须	单品编码单品条码单品名称模糊查询
tenCode	string	非必须	租户编码，若不填则取登陆信息

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
total	integer	非必须	总数据量
data	object []	非必须		item 类型: object
├─ id	number	必须	单品id
├─ spName	string	必须	单品名称	最大长度: 255
├─ spCode	string	必须	单品编码	最大长度: 50
├─ spBarCode	string	必须	单品条码	最大长度: 50
├─ spNickName	string	非必须	单品别名	最大长度: 50
├─ categoryCode	string	必须	品类编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ categoryName	string	必须	品类名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ brandCode	string	必须	品牌编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ brandName	string	必须	品牌名称(通过租户主数据品类部分接口获取)	最大长度: 255
├─ stockUnitCode	string	非必须	单位(通过平台主数据基础数据部分获取)	最大长度: 10
├─ salesPrice	number	非必须	建议零售价(小数点后保留2位)	最小值: 0
├─ spDescribe	string	非必须	单品描述	最大长度: 255
├─ spImgUrl	string	必须	单品图片(OSS上传路径)	最大长度: 255
├─ isPackaging	integer	必须	是否包装单品(0:否 1:是)	枚举: 0,1 枚举备注:
├─ packSpCode	string	非必须	包装单品编码(如果选择包装单品则必填)	最大长度: 50
├─ packSpCount	integer	非必须	包装单品数量(如果选择包装单品则必填)	最小值: 1
├─ sizeLong	integer	非必须	单品包装尺寸(长度单位:毫米mm)
├─ sizeWide	integer	非必须	单品包装尺寸(宽度单位:毫米mm)
├─ sizeHigh	integer	非必须	单品包装尺寸(高度单位:毫米mm)
├─ shelfLife	integer	非必须	保质期(单位:天)
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
success	boolean	必须	状态
traceId	string	必须	请求标识

单品新增或编辑

基本信息

Path： /api/singleproduct/v1/productApi/saveOrUpdate

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
spName	string	必须	单品名称(只能由字母、数字和汉字组成)	最大长度: 255
spCode	string	必须	单品编码(用来定位编辑的单品,实际不支持修改)	最大长度: 50
spBarCode	string	必须	单品条码(只能由字母和数字组成)
spNickName	string	非必须	单品别名(只能由字母、数字和汉字组成)	最大长度: 50
categoryCode	string	必须	品类编码(由租户主数据品类部分接口获取)	最大长度: 50
categoryBrand	string	必须	品类名称(由租户主数据品类部分接口获取,需要完整填写,各级品类按父子层级顺序用\"/\"分隔)	最大长度: 255
brandCode	string	必须	品牌编码(由租户主数据品牌部分接口获取)	最大长度: 50
brandName	string	必须	品类名称(由租户主数据品牌部分接口获取,需要完整填写,各级品牌按父子层级顺序用\"/\"分隔)	最大长度: 255
stockUnitCode	string	必须	单品单位(由平台主数据基础数据部分接口获取)	最大长度: 10
salesPrice	number	非必须	建议零售价(小数点后保留两位)	最小值: 0
spImgUrl	string	非必须	单品图片(OSS上传路径)	最大长度: 255
spDescribe	string	非必须	单品描述	最大长度: 255
isPackaging	integer	必须	是否包装单品(0:否 1:是)	枚举: 0,1
packSpCode	string	非必须	包装单品编码(如果选择包装单品则必填)	最大长度: 50
packSpCount	integer	非必须	包装单品数量(如果选择包装单品则必填)	最小值: 1
sizeLong	integer	非必须	单品包装尺寸(长度单位:毫米mm)	最小值: 1
sizeWide	integer	非必须	单品包装尺寸(宽度单位:毫米mm)	最小值: 1
sizeHigh	integer	非必须	单品包装尺寸(高度单位:毫米mm)	最小值: 1
shelfLife	integer	非必须	单品保质期(单位:天)	最小值: 1
status	integer	必须	数据状态(0:禁用 1:启用)	枚举: 0,1
extraField	object	非必须	扩展字段(扩展字段编码-扩展字段值,多选题值多个选项用";"分隔)
├─ extraCode	string	必须	扩展字段编码
├─ extraValue	string	必须	扩展字段值

返回数据

{"type":"object","title":"title","properties":{}}

单品列表(不分页)

基本信息

Path： /api/singleproduct/v1/productApi/listBatch

Method： POST

接口描述：

请求参数

Headers

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

Query

参数名称	是否必须	示例	备注
tenCode	否	租户编码,不填时取登陆信息

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
data	object []	非必须		item 类型: object
├─ id	number	必须	单品id
├─ spName	string	必须	单品名称	最大长度: 255
├─ spCode	string	必须	单品编码	最大长度: 50
├─ spBarCode	string	必须	单品条码	最大长度: 50
├─ spNickName	string	非必须	单品别名	最大长度: 50
├─ categoryCode	string	必须	品类编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ categoryName	string	必须	品类名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ brandCode	string	必须	品牌编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ brandName	string	必须	品牌名称(通过租户主数据品类部分接口获取)	最大长度: 255
├─ stockUnitCode	string	非必须	单位(通过平台主数据基础数据部分获取)	最大长度: 10
├─ salesPrice	number	非必须	建议零售价(小数点后保留2位)	最小值: 0
├─ spDescribe	string	非必须	单品描述	最大长度: 255
├─ spImgUrl	string	必须	单品图片(OSS上传路径)	最大长度: 255
├─ isPackaging	integer	必须	是否包装单品(0:否 1:是)	枚举: 0,1 枚举备注:
├─ packSpCode	string	非必须	包装单品编码(如果选择包装单品则必填)	最大长度: 50
├─ packSpCount	integer	非必须	包装单品数量(如果选择包装单品则必填)	最小值: 1
├─ sizeLong	integer	非必须	单品包装尺寸(长度单位:毫米mm)
├─ sizeWide	integer	非必须	单品包装尺寸(宽度单位:毫米mm)
├─ sizeHigh	integer	非必须	单品包装尺寸(高度单位:毫米mm)
├─ shelfLife	integer	非必须	保质期(单位:天)
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
success	boolean	必须	状态
traceId	string	必须	请求标识

单品详情

基本信息

Path： /api/singleproduct/v1/productApi/get

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
spCode	是	STS000P9QN9P8GPSK	单品编码
tenCode	否		租户编码，不填则取登陆信息

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
total	integer	非必须	总数据量
data	object	非必须
├─ id	number	必须	单品id
├─ spUCode	string	必须	单品跨租户的全局唯一编码
├─ spName	string	必须	单品名称	最大长度: 255
├─ spCode	string	必须	单品编码(租户内唯一)	最大长度: 50
├─ spBarCode	string	必须	单品条码	最大长度: 50
├─ spNickName	string	非必须	单品别名	最大长度: 50
├─ categoryCode	string	必须	品类编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ categoryName	string	必须	品类名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ brandCode	string	必须	品牌编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ brandName	string	必须	品牌名称(通过租户主数据品类部分接口获取)	最大长度: 255
├─ stockUnitCode	string	非必须	单位(通过平台主数据基础数据部分获取)	最大长度: 10
├─ salesPrice	number	非必须	建议零售价(小数点后保留2位)	最小值: 0
├─ spDescribe	string	非必须	单品描述	最大长度: 255
├─ spImgUrl	string	非必须	单品图片(OSS上传路径)	最大长度: 255
├─ isPackaging	integer	非必须	是否包装单品(0:否 1:是)	枚举: 0,1 枚举备注:
├─ packSpCode	string	非必须	包装单品编码(如果选择包装单品则必填)	最大长度: 50
├─ packSpCount	integer	非必须	包装单品数量(如果选择包装单品则必填)	最小值: 1
├─ sizeLong	integer	非必须	单品包装尺寸(长度单位:毫米mm)
├─ sizeWide	integer	非必须	单品包装尺寸(宽度单位:毫米mm)
├─ sizeHigh	integer	非必须	单品包装尺寸(高度单位:毫米mm)
├─ shelfLife	integer	非必须	保质期(单位:天)
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
success	boolean	必须	状态
traceId	string	必须	请求标识

单品详情(通过条形码查询)

基本信息

Path： /api/singleproduct/v1/productApi/getByBarCode

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
spBarCode	是	5C235DOP456712	单品条码

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
total	integer	非必须	总数据量
data	object	非必须
├─ id	number	必须	单品id
├─ spUCode	string	必须	单品跨租户的全局唯一编码
├─ spName	string	必须	单品名称	最大长度: 255
├─ spCode	string	必须	单品编码	最大长度: 50
├─ spBarCode	string	必须	单品条码	最大长度: 50
├─ spNickName	string	非必须	单品别名	最大长度: 50
├─ categoryCode	string	必须	品类编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ categoryName	string	必须	品类名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ brandCode	string	必须	品牌编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ brandName	string	必须	品牌名称(通过租户主数据品类部分接口获取)	最大长度: 255
├─ stockUnitCode	string	非必须	单位(通过平台主数据基础数据部分获取)	最大长度: 10
├─ salesPrice	number	非必须	建议零售价(小数点后保留2位)	最小值: 0
├─ spDescribe	string	非必须	单品描述	最大长度: 255
├─ spImgUrl	string	非必须	单品图片(OSS上传路径)	最大长度: 255
├─ isPackaging	integer	非必须	是否包装单品(0:否 1:是)	枚举: 0,1 枚举备注:
├─ packSpCode	string	非必须	包装单品编码(如果选择包装单品则必填)	最大长度: 50
├─ packSpCount	integer	非必须	包装单品数量(如果选择包装单品则必填)	最小值: 1
├─ sizeLong	integer	非必须	单品包装尺寸(长度单位:毫米mm)
├─ sizeWide	integer	非必须	单品包装尺寸(宽度单位:毫米mm)
├─ sizeHigh	integer	非必须	单品包装尺寸(高度单位:毫米mm)
├─ shelfLife	integer	非必须	保质期(单位:天)
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
success	boolean	必须	状态
traceId	string	必须	请求标识

包装内单品列表

基本信息

Path： /api/singleproduct/v1/productApi/listPackage

Method： POST

接口描述：

请求参数说明

参数名	必选	类型	说明
currentCode	是	String	当前单品Code
pageSize	是	Integer	每页显示条数(分页用,可选每页10/20/50/100条)
pageNum	是	Integer	当前页数
spName	否	String	单品名称
spCode	否	String	单品编码
spBarCode	否	String	单品条码

响应值说明

参数名	类型	说明
id	Integer	单品id
spCode	String	单品编码
spName	String	单品名称
spBarCode	String	单品条码
spNickName	String	单品简称
spDescribe	String	单品描述
brandCode	String	品牌编码
brandName	String	品牌名称
categoryCode	String	品类编码
categoryName	String	品类名称
stockUnitCode	String	单位
salesPrice	BigDecimal(10,2)	售价
sizeLong	Integer	长度(单位:毫米)
sizeWide	Integer	宽度(单位:毫米)
sizeHigh	Integer	高度(单位:毫米)
shelfLife	Integer	保质期(单位:天)
spImgUrl	String	单品图片url
status	Integer	数据状态(0:禁用 1:启用)
singleProductExtra	JsonArray	扩展字段列表
--id	Integer	扩展字段id
--extraCode	String	扩展字段编码
--extraName	String	扩展字段名称
--selectValue	String	扩展字段选项配置值
--extraType	String	扩展字段类型(text文本，number数字，date日期，radio单选, checkbox多选)
--extraValue	String	扩展字段值
--extraTips	String	扩展字段提示语
--isEmpty	Integer	扩展字段是否必填
--isUnique	Integer	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)
--isEdit	Integer	扩展字段是否可编辑
--status	Integer	数据状态

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
currentCode	string	必须	当前单品编码
spName	string	非必须	单品名称
spCode	string	非必须	单品编码
spBarCode	string	非必须	单品条码
pageSize	integer	必须	每页显示条数(选填选填10、20、50或100)	枚举: 10,20,50,100
pageNum	integer	必须	当前页数(正整数)	最小值: 0

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
total	integer	非必须	总数据量
data	object []	非必须		item 类型: object
├─ id	number	必须	单品id
├─ spName	string	必须	单品名称	最大长度: 255
├─ spCode	string	必须	单品编码	最大长度: 50
├─ spBarCode	string	必须	单品条码	最大长度: 50
├─ spNickName	string	非必须	单品别名	最大长度: 50
├─ categoryCode	string	必须	品类编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ categoryName	string	必须	品类名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ brandCode	string	必须	品牌编码(通过租户主数据品类部分接口获取)	最大长度: 50
├─ brandName	string	必须	品牌名称(通过租户主数据品类部分接口获取)	最大长度: 255
├─ stockUnitCode	string	非必须	单位(通过平台主数据基础数据部分获取)	最大长度: 10
├─ salesPrice	number	非必须	建议零售价(小数点后保留2位)	最小值: 0
├─ spDescribe	string	非必须	单品描述	最大长度: 255
├─ spImgUrl	string	必须	单品图片(OSS上传路径)	最大长度: 255
├─ isPackaging	integer	必须	是否包装单品(0:否 1:是)	枚举: 0,1 枚举备注:
├─ packSpCode	string	非必须	包装单品编码(如果选择包装单品则必填)	最大长度: 50
├─ packSpCount	integer	非必须	包装单品数量(如果选择包装单品则必填)	最小值: 1
├─ sizeLong	integer	非必须	单品包装尺寸(长度单位:毫米mm)
├─ sizeWide	integer	非必须	单品包装尺寸(宽度单位:毫米mm)
├─ sizeHigh	integer	非必须	单品包装尺寸(高度单位:毫米mm)
├─ shelfLife	integer	非必须	保质期(单位:天)
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ field_10	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
success	boolean	必须	状态
traceId	string	必须	请求标识

单品状态修改

基本信息

Path： /api/singleproduct/v1/productApi/updateStatus

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
codes	string []	必须	需要批量修改状态的单品编码列表	item 类型: string
├─		非必须	单品编码
status	integer	必须	0:禁用 1:启用	枚举: 0,1

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	状态
errCode	string	必须	错误码
errMessage	string	必须	错误信息
traceId	string	非必须	请求标识

终端管理API

扩展字段列表

基本信息

Path： /api/terminal/v1/extraApi/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
funCode	是	terminal	扩展字段功能标识(terminal:终端,singleproduct:单品)

返回数据

名称	类型	是否必须	备注	其他信息
success	string	必须	状态
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
data	object []	必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ status	integer	必须	数据状态(0:禁用 1:启用)	枚举: 0,1
traceId	string	必须	请求标识

租户终端更新

基本信息

Path： /api/terminal/v1/terminalApi/update

Method： POST

接口描述：

请求参数

1.terminalName+address,租户内唯一
2.province，provinceCode，city，cityCode，area，areaCode，使用平台区域数据返回的值及编码
3.只会更新传入的字段，没有传值的字段则不更新

请求参数

Headers

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

Body

名称	类型	是否必须	备注
terminalName	string	非必须	终端名称
terminalCode	string	必须	终端唯一编码(按照系统规则生成或用户输入)
scaleType	integer	非必须	规模类型(1：独立 2：连锁)
channelCode	string	非必须	渠道编码
channelName	string	非必须	渠道名称
province	string	非必须	省
provinceCode	string	非必须	省编码
city	string	非必须	市
cityCode	string	非必须	市编码
area	string	非必须	区
areaCode	string	非必须	区编码
town	string	非必须	镇
address	string	非必须	地址(平台主数据)
baiduLon	number	非必须	纬度lat(百度)
baiduLat	number	非必须	经度lon(百度)
phone	string	非必须	联系人电话，传已经加密过的电话串
doorPhoto	string	非必须	门头照

返回数据

名称	类型	是否必须	备注
success	boolean	必须
errorCode	string	非必须	错误编码
errorMessage	string	非必须	错误信息
showType	number	非必须
traceId	string	非必须

终端列表

基本信息

Path： /api/terminal/v1/terminalApi/list

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
terminalNameOrTerminalCode	string	非必须	终端名称或编码
terminalName	string	非必须	终端名称
termianlCode	string	非必须	终端编码
terminalOriginCodeOrMemo	string	非必须	终端来源标志或终端来源描述
channelName	string	非必须	渠道名称
province	string	非必须	省
city	string	非必须	市
area	string	非必须	区
address	string	非必须	终端地址
scaleType	integer	非必须	规模类型(1:独立 2:连锁)	枚举: 1,2
status	integer	非必须	数据状态(0:禁用 1:启用)	枚举: 0,1
pageSize	integer	必须	每页显示条数(选填选填10、20、50或100)	枚举: 10,20,50,100
pageNum	integer	必须	当前页数(正整数)	最小值: 0

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
total	integer	非必须	总数据量
data	object []	非必须		item 类型: object
├─ id	number	必须	终端id
├─ terminalName	string	必须	终端名称	最大长度: 255
├─ terminalCode	string	必须	终端编码	最大长度: 50
├─ channelCode	string	必须	渠道编码(通过租户主数据渠道部分接口获取)	最大长度: 50
├─ channelName	string	必须	渠道名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ province	string	必须	省(通过平台主数据区域部分接口获取)	最大长度: 50
├─ provinceCode	string	必须	省编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ city	string	必须	市(通过平台主数据区域部分接口获取)	最大长度: 50
├─ cityCode	string	必须	市编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ area	string	必须	区(通过平台主数据区域部分接口获取)	最大长度: 50
├─ areaCode	string	必须	区编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ town	string	非必须	乡镇	最大长度: 50
├─ address	string	必须	终端地址(小数点后保留6位)	最大长度: 255
├─ baiduLat	number	必须	终端纬度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ baiduLon	number	必须	终端经度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ scaleType	integer	非必须	规模类型(1:独立 2:连锁)	枚举: 0,1
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
├─ licenseCode	string	非必须	统一社会信用代码	最大长度: 50
├─ licenseName	string	非必须	经营者	最大长度: 100
├─ licenseAddress	string	非必须	经营场所	最大长度: 255
├─ licenseType	string	非必须	经营类型	最大长度: 50
├─ licenseDay	string	非必须	注册日期	最大长度: 32
├─ licenseScope	string	非必须	经营范围	最大长度: 500
├─ licenseExpiry	string	非必须	营业执照有效期	最大长度: 50
├─ licensePhoto	string	非必须	营业执照图片(OSS存储路径)	最大长度: 255
├─ terminalOriginCode	string	非必须	终端来源标志	最大长度: 50
├─ terminalOriginMemo	string	非必须	终端来源描述	最大长度: 200
success	boolean	必须	状态
traceId	string	必须	请求标识

终端列表(不分页)

基本信息

Path： /api/terminal/v1/terminalApi/listBatch

Method： POST

接口描述：

请求参数

Headers

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

Body

名称

类型

是否必须

默认值

备注

其他信息

string []

非必须

终端编码列表

最小数量: 0

元素是否都不同: true

最大数量: 200

item 类型: string

├─

非必须

终端编码

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
data	object []	非必须		item 类型: object
├─ id	number	必须	终端id
├─ terminalName	string	必须	终端名称	最大长度: 255
├─ terminalCode	string	必须	终端编码	最大长度: 50
├─ channelCode	string	必须	渠道编码(通过租户主数据渠道部分接口获取)	最大长度: 50
├─ channelName	string	必须	渠道名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ province	string	必须	省(通过平台主数据区域部分接口获取)	最大长度: 50
├─ provinceCode	string	必须	省编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ city	string	必须	市(通过平台主数据区域部分接口获取)	最大长度: 50
├─ cityCode	string	必须	市编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ area	string	必须	区(通过平台主数据区域部分接口获取)	最大长度: 50
├─ areaCode	string	必须	区编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ town	string	非必须	乡镇	最大长度: 50
├─ address	string	必须	终端地址(小数点后保留6位)	最大长度: 255
├─ baiduLat	number	必须	终端纬度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ baiduLon	number	必须	终端经度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ scaleType	integer	非必须	规模类型(1:独立 2:连锁)	枚举: 0,1
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
├─ licenseCode	string	非必须	统一社会信用代码	最大长度: 50
├─ licenseName	string	非必须	经营者	最大长度: 100
├─ licenseAddress	string	非必须	经营场所	最大长度: 255
├─ licenseType	string	非必须	经营类型	最大长度: 50
├─ licenseDay	string	非必须	注册日期	最大长度: 32
├─ licenseScope	string	非必须	经营范围	最大长度: 500
├─ licenseExpiry	string	非必须	营业执照有效期	最大长度: 50
├─ licensePhoto	string	非必须	营业执照图片(OSS存储路径)	最大长度: 255
├─ terminalOriginCode	string	非必须	终端来源标志	最大长度: 50
├─ terminalOriginMemo	string	非必须	终端来源描述	最大长度: 200
success	boolean	必须	状态
traceId	string	必须	请求标识

终端列表(不分页)--根据渠道编码、省市区编码返回终端信息

基本信息

Path： /api/terminal/v1/terminalApi/listTerminalAuth

Method： POST

接口描述：

请求参数

{ "conditionList":[ { "addCode":"", "addLevel":"", "channelCode":"STCH003UH4FAQXS", "terminalUCode":"STTU00KR2H9SEFD8", "terminalCode":"", "terminalName":"测试" }, { "addCode":"", "addLevel":"", "channelCode":"STCH003UH4FAQXS", "terminalUCode":"STTU00KRN52KLJ5D8", "terminalCode":"", "terminalName":"测试" } ], "status":1, "tenCode":"test", "pageSize":10, "pageNum":0

}

返回参数

{
    "success": true,
    "data": [
        {
            "id": 4,
            "terminalCode": "STT000KTESHPVWMV",
            "terminalName": "测试9",
            "channelCode": "STCH003CYJFKWGUS",
            "channelName": "测试1/测试01",
            "province": "北京市",
            "provinceCode": "110000",
            "city": "北京市",
            "cityCode": "110100",
            "area": "西城区",
            "areaCode": "110102",
            "town": "",
            "address": "1111111",
            "doorPhoto": null,
            "phone": null,
            "baiduLat": 39.911867000,
            "baiduLon": 116.420046000,
            "scaleType": 1,
            "extraField": [],
            "status": 1,
            "terminalOriginCode": "tCsUN08mJDEDG0t2ZoeamZaI",
            "terminalOriginMemo": "来源租户",
            "terminalUCode": "STTU00KRN52KLJ5D8"
        },
        {
            "id": 1,
            "terminalCode": "STT0003JKF9ASJXS",
            "terminalName": "测试9",
            "channelCode": "STCH003CYJFKWGUS",
            "channelName": "测试1/测试01",
            "province": "北京市",
            "provinceCode": "110000",
            "city": "北京市",
            "cityCode": "110100",
            "area": "东城区",
            "areaCode": "110101",
            "town": "",
            "address": "111111",
            "doorPhoto": "https://fmes.oss-cn-shanghai.aliyuncs.com/test_dev/terminal/20220616/uTHCG0K9DBBpSZplxv9Zj754OxxSfDh6_terminaldoor_c726faf58d244a328772669eec9254aa.jpg?Expires=1693275500&OSSAccessKeyId=LTAI4GH389TyyoCe1VXKeAEB&Signature=On8wgHZTL3h+jiLQh/iB3UpG1xI=",
            "phone": "K2001017690548895302",
            "baiduLat": 39.910925000,
            "baiduLon": 116.413384000,
            "scaleType": 1,
            "extraField": [
                {
                    "id": 7,
                    "extraName": "测试参数1",
                    "extraCode": "terminal1",
                    "selectValue": "",
                    "status": 0,
                    "isEmpty": 0,
                    "isEdit": 0,
                    "isUnique": 0,
                    "extraType": "text",
                    "extraTips": "12",
                    "extraValue": "测试"
                }
            ],
            "status": 1,
            "terminalOriginCode": "tCsUN08mJDEDG0t2ZoeamZaI",
            "terminalOriginMemo": "来源租户",
            "terminalUCode": "STTU00KR2H9SEFD8"
        }
    ],
    "traceId": "67b77ba68873a04fd4b44e34e28896da",
    "total": 2
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
conditionList	object []	必须	conditionList中每个Item有多个条件时取交集查询，多个Item取并集查询；按照条件优先级筛选返回数据：terminalUCode，terminalCode，省市区，渠道	item 类型: object
├─ addCode	string	非必须	省市区编码
├─ addLevel	string	非必须	省市区编码对应层级，省市区编码非空时，此字段必填；1省，2市，3区
├─ channelCode	string	非必须	渠道编码，查询时包含该渠道及其对应的子渠道
├─ terminalUCode	string	非必须	终端唯一编码（平台内唯一）	最大长度: 50
├─ terminalCode	string	非必须	终端编码（租户内唯一）
├─ terminalName	string	非必须	终端名称
status	integer	非必须	数据状态(0:禁用 1:启用)，默认返回所有数据
tenCode	string	必须	租户编码
pageSize	integer	非必须	每页条数
pageNum	integer	非必须	页码，从0开始

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
data	object []	非必须		item 类型: object
├─ id	number	必须	终端id
├─ terminalName	string	必须	终端名称	最大长度: 255
├─ terminalCode	string	必须	终端编码（租户内唯一）	最大长度: 50
├─ terminalUCode	string	必须	终端唯一编码（平台内唯一）
├─ channelCode	string	必须	渠道编码(通过租户主数据渠道部分接口获取)	最大长度: 50
├─ channelName	string	必须	渠道名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ province	string	必须	省(通过平台主数据区域部分接口获取)	最大长度: 50
├─ provinceCode	string	必须	省编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ city	string	必须	市(通过平台主数据区域部分接口获取)	最大长度: 50
├─ cityCode	string	必须	市编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ area	string	必须	区(通过平台主数据区域部分接口获取)	最大长度: 50
├─ areaCode	string	必须	区编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ town	string	非必须	乡镇	最大长度: 50
├─ address	string	必须	终端地址	最大长度: 255
├─ baiduLat	number	必须	终端纬度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ baiduLon	number	必须	终端经度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ scaleType	integer	非必须	规模类型(1:独立 2:连锁)	枚举: 1,2
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ terminalOriginCode	string	非必须	终端来源标志	最大长度: 50
├─ terminalOriginMemo	string	非必须	终端来源描述	最大长度: 200
├─ doorPhoto	string	非必须	门头照
├─ phone	string	非必须	联系人加密电话
├─ extraField	object []	非必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
success	boolean	必须	状态
traceId	string	必须	请求标识
total	integer	必须	总条数

终端插入编辑发送总线

基本信息

Path： /msg

Method： GET

接口描述：

总线接收配置
terminal-save-in-0:
destination:com.myfmes.terminal.terminalSave
binder:nats
group:group-channel-IsUsed
consumer:
concurrency:10
max-attempts:3

请求参数

返回数据

名称	类型	是否必须	备注
id	string	必须	终端id
terminalName	string	必须	终端名称
terminalCode	string	必须	终端编码
status	string	必须	数据状态 1:启用 0:禁用 2:未激活 3:注销 4:删除
channelCode	string	必须	渠道编码
channelName	string	必须	渠道
kindsItem1	string	非必须	一级渠道(已弃用)
kindsItem2	string	非必须	二级渠道(已弃用)
channel1	string	非必须	三级渠道(已弃用)
childChannel	string	非必须	四级渠道(已弃用)
provinceCode	string	必须	省编码
province	string	必须	省
cityCode	string	必须	市编码
city	string	必须	市
areaCode	string	必须	区编码
area	string	必须	区
town	string	非必须	乡镇
address	string	必须	终端地址
scaleType	string	必须	规模类型 1:独立 2:连锁
baiduLon	string	必须	经度
baiduLat	string	必须	纬度
terminalOriginCode	string	必须	来源编码（默认为self）
terminalOriginMemo	string	必须	来源描述（默认为self）
phone	string	非必须	联系电话
doorPhoto	string	非必须	门头照(相对存储路径)
licensePhoto	string	非必须	营业执照(相对存储路径)
licenseCode	string	非必须	统一社会信用代码
licenseName	string	非必须	经营者
licenseAddress	string	非必须	经营场所
licenseDay	string	非必须	注册日期
licenseType	string	非必须	执照类型
licenseExpiry	string	非必须	有效期
licenseScope	string	非必须	经营范围
terminalExtraStr	string	非必须	扩展字段(json格式key-value数据 key:扩展字段编码 value:扩展字段值)

终端新增

基本信息

Path： /api/terminal/v1/terminalApi/add

Method： POST

接口描述：

注意，这里是终端名称+地址+终端来源标识确定唯一，若存在则直接返回，若不存在则插入
参数示例：
{

"terminalName": "比优特超市(印象城店)",
"terminalCode": "sssss01",
"province": "辽宁",
"city": "大连市",
"area": "甘井子区",
"address": "大连市中山路印象城B座负一层",
"channelName": "小店1/2的2",
"tenCode": "test",
"scaleType": 1,
"phone": "",
"terminalOriginCode":"API",
"terminalOriginMemo": "API"
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
terminalName	string	必须	终端名称(只能由字母、数字和汉字组成)	最大长度: 255
terminalCode	string	非必须	终端编码(不填自动生成,只能由字母和数字组成)	最大长度: 50
scaleType	integer	必须	规模类型(1:独立 2:连锁)	枚举: 1,2
channelName	string	必须	渠道名称(由租户主数据渠道部份接口获取,需要完整填写,各级渠道按父子层级顺序用"/"分隔，最多支持四级，如果渠道不在租户内则新增)	最大长度: 255
province	string	必须	省(通过平台主数据区域部分接口获取)	最大长度: 50
city	string	必须	市(通过平台主数据区域部分接口获取)	最大长度: 50
area	string	必须	区(通过平台主数据区域部分接口获取)	最大长度: 50
town	string	非必须	镇	最大长度: 50
address	string	必须	地址	最大长度: 255
baiduLon	number	非必须	终端经度(小数点后保留6位,不填写则由终端地址通过逆地理编码生成)	最大值: 180 最小值: 0
baiduLat	number	非必须	终端纬度(小数点后保留6位,不填写则由终端地址通过逆地理编码生成)	最大值: 90 最小值: 0
tenCode	string	必须	租户编码(不能超过64位)	最大长度: 64
userCode	string	非必须	创建人/修改人(不能超过64位)	最大长度: 64
phone	string	非必须	手机号，密文传入	最大长度: 13
doorPhoto	string	非必须	门头照	最大长度: 255
terminalOriginCode	string	非必须	终端来源标识	最大长度: 50
terminalOriginMemo	string	非必须	终端来源描述	最大长度: 200
terminalExtraStr	string	非必须	扩展字段(json格式key-value数据 key:扩展字段编码 value:扩展字段值)

返回数据

名称	类型	是否必须	备注
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
success	boolean	必须	状态
traceId	string	必须	请求标识
data	object	必须
├─ terminalCode	string	必须	终端编码(新增成功时返回)
├─ terminalUCode	string	必须	终端唯一编码(新增成功时返回)

终端新增API --List传输

基本信息

Path： /api/terminal/v1/terminalApi/addList

Method： POST

接口描述：

手机号需要传密文
1、列表传入：
1）如果列表内有重复数据（终端名称和地址都相同的数据将会被认为是重复数据），那么无法入库
2）如果列表内有一条数据校验失败，那么所有的数据都不能入库
3）返回的错误数据都会放在errMessage中，内容为数据排序编码+终端名称+错误原因
4）如果全部校验完没有问题，会将所有的终端的数据排序编码+终端编码都返回
5）一次最多导入1000条数据

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ terminalName	string	必须	终端名称(只能由字母、数字和汉字组成)
├─ terminalCode	string	非必须	终端编码(不填自动生成,只能由字母和数字组成)
├─ itemNo	string	必须	序号，每条数据对应唯一的序号
├─ province	string	必须	省(通过平台主数据区域部分接口获取)
├─ city	string	必须	市(通过平台主数据区域部分接口获取)
├─ area	string	必须	区(通过平台主数据区域部分接口获取)
├─ address	string	必须	地址
├─ town	string	非必须	镇
├─ channelName	string	必须	渠道名称(由租户主数据渠道部份接口获取,需要完整填写,各级渠道按父子层级顺序用"/"分隔，如果渠道不在租户内则新增)
├─ tenCode	string	必须	租户编码(不能超过64位)
├─ scaleType	number	必须	规模类型(1:独立 2:连锁)
├─ baiduLat	number	非必须	终端纬度(小数点后保留6位,不填写则由终端地址通过逆地理编码生成)
├─ baiduLon	number	非必须	终端经度(小数点后保留6位,不填写则由终端地址通过逆地理编码生成)
├─ userCode	string	必须	创建人/修改人(不能超过64位)
├─ doorPhoto	string	非必须	门头照
├─ terminalExtraStr	string	非必须	扩展字段(json格式key-value数据 key:扩展字段编码 value:扩展字段值)
├─ phone	string	非必须	手机号，需要传密文
├─ terminalOriginCode	string	非必须	终端来源标志	最大长度: 50
├─ terminalOriginMemo	string	非必须	终端来源描述	最大长度: 200

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息，返回每一个终端对应的错误信息
success	boolean	必须	状态
traceId	string	必须	请求标识
data	object []	必须		item 类型: object
├─ terminalCode	string	必须	终端编码
├─ itemNo	string	必须	序号

终端状态修改

基本信息

Path： /api/terminal/v1/terminalApi/updateStatus

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
codes	string []	必须	需要批量修改状态的终端编码列表	item 类型: string
├─		非必须	终端编码
status	integer	必须	0:禁用 1:启用	枚举: 0,1

返回数据

名称	类型	是否必须	备注
success	boolean	非必须	状态
errCode	string	必须	错误码
errMessage	string	必须	错误信息
traceId	string	非必须	请求标识

终端营业执照信息编辑

基本信息

Path： /api/terminal/v1/terminalApi/updateLicense

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
terminalCode	text	是	STT000PHXLS7FUU4L	终端编码
licensePhoto	file	否		营业执照图片文件
licenseCode	text	否	91330304MA2AR5RX2E	统一社会信用代码
licenseName	text	否	温州佳悦企业管理有限公司	经营者
licenseAddress	text	否	浙江省温州市瓯海区娄桥街道中汇路587号317	经营场所
licenseType	text	否	有限责任公司(自然人投资或控股的法人独资)	经营类型
licenseDay	text	否	2019年03月01日	注册日期
licenseScope	text	否	企业管理咨询,商务管理咨询(不含金融、证券,期货及其他需专项审批项目)会务服务、展览展示服务;房地产营销策划。(依法须经批准的项目,经相关部门批准后方可开展经营活动	经营范围
licenseExpiry	text	否	2019年03月01日至长期	有效期

返回数据

名称	类型	是否必须	备注
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
success	boolean	必须	状态
traceId	string	必须	请求标识

终端详情

基本信息

Path： /api/terminal/v1/terminalApi/get

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
terminalCode	是	STT0003U3GRZRAFNZ	终端编码

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
data	object	必须	终端信息
├─ id	number	必须	终端id
├─ terminalName	string	必须	终端名称	最大长度: 255
├─ terminalCode	string	必须	终端编码	最大长度: 50
├─ channelCode	string	必须	渠道编码(通过租户主数据渠道部分接口获取)	最大长度: 50
├─ channelName	string	必须	渠道名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ province	string	必须	省(通过平台主数据区域部分接口获取)	最大长度: 50
├─ provinceCode	string	必须	省编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ city	string	必须	市(通过平台主数据区域部分接口获取)	最大长度: 50
├─ cityCode	string	必须	市编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ area	string	必须	区(通过平台主数据区域部分接口获取)	最大长度: 50
├─ areaCode	string	必须	区编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ town	string	非必须	乡镇	最大长度: 50
├─ address	string	必须	终端地址(小数点后保留6位)	最大长度: 255
├─ baiduLat	number	必须	终端纬度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ baiduLon	number	必须	终端经度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ scaleType	integer	非必须	规模类型(1:独立 2:连锁)	枚举: 0,1
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
├─ licenseCode	string	非必须	统一社会信用代码	最大长度: 50
├─ licenseName	string	非必须	经营者	最大长度: 100
├─ licenseAddress	string	非必须	经营场所	最大长度: 255
├─ licenseType	string	非必须	经营类型	最大长度: 50
├─ licenseDay	string	非必须	注册日期	最大长度: 32
├─ licenseScope	string	非必须	经营范围	最大长度: 500
├─ licenseExpiry	string	非必须	营业执照有效期	最大长度: 50
├─ licensePhoto	string	非必须	营业执照图片(OSS存储路径)	最大长度: 255
├─ terminalOriginCode	string	非必须	终端来源标志	最大长度: 50
├─ terminalOriginMemo	string	非必须	终端来源描述	最大长度: 200
success	boolean	必须	状态
traceId	string	必须	请求标识

终端详情By编码(终端编码OR终端唯一编码)

基本信息

Path： /api/terminal/v1/terminalApi/getTerminalInfoByCode

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
tenCode	是	tCZFY0KA78CEiWbFu5Fk15Pl	租户编码
terminalCode	否	STT000H78MVCTZYZK	终端编码
terminalUCode	否	STTU00H7VGV2EU8ZK	终端唯一编码

返回数据

名称	类型	是否必须	备注	其他信息
errCode	string	非必须	错误码
errMessage	string	非必须	错误信息
data	object	必须	终端信息
├─ id	number	必须	终端id
├─ terminalName	string	必须	终端名称	最大长度: 255
├─ terminalCode	string	必须	终端编码	最大长度: 50
├─ channelCode	string	必须	渠道编码(通过租户主数据渠道部分接口获取)	最大长度: 50
├─ channelName	string	必须	渠道名称(多级渠道名称之间用"/"分隔)	最大长度: 255
├─ province	string	必须	省(通过平台主数据区域部分接口获取)	最大长度: 50
├─ provinceCode	string	必须	省编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ city	string	必须	市(通过平台主数据区域部分接口获取)	最大长度: 50
├─ cityCode	string	必须	市编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ area	string	必须	区(通过平台主数据区域部分接口获取)	最大长度: 50
├─ areaCode	string	必须	区编码(通过平台主数据区域部分接口获取)	最大长度: 50
├─ town	string	非必须	乡镇	最大长度: 50
├─ address	string	必须	终端地址(小数点后保留6位)	最大长度: 255
├─ baiduLat	number	必须	终端纬度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ baiduLon	number	必须	终端经度(小数点后保留6位)	最大值: 1000 最小值: 0
├─ scaleType	integer	非必须	规模类型(1:独立 2:连锁)	枚举: 0,1
├─ status	integer	必须	数据状态(0:禁用 1:启用)
├─ extraField	object []	必须	扩展字段列表	item 类型: object
├─ id	integer	必须	扩展字段id
├─ extraName	string	必须	扩展字段名称	最大长度: 50
├─ extraCode	string	必须	扩展字段编码	最大长度: 64
├─ extraType	string	必须	扩展字段类型(text:文本 number:数字 radio:单选 checkbox:多选)	枚举: text,number,radio,checkbox
├─ isEmpty	integer	必须	扩展字段是否必填(0:否 1:是)	枚举: 0,1
├─ isEdit	integer	必须	扩展字段是否可编辑(0:否 1:是)	枚举: 0,1
├─ isUnique	integer	必须	扩展字段是否唯一(字段标记唯一，则扩展字段值不能重复)(0:否 1:是)
├─ extraTips	string	必须	扩展字段提示语	最大长度: 64
├─ selectValue	string	非必须	扩展字段选项值(当扩展字段类型为单选或多选时填写,多个选项之间用";"分隔)	最大长度: 64
├─ extraValue	string	必须	扩展字段值(用户存储的值)	最大长度: 255
├─ licenseCode	string	非必须	统一社会信用代码	最大长度: 50
├─ licenseName	string	非必须	经营者	最大长度: 100
├─ licenseAddress	string	非必须	经营场所	最大长度: 255
├─ licenseType	string	非必须	经营类型	最大长度: 50
├─ licenseDay	string	非必须	注册日期	最大长度: 32
├─ licenseScope	string	非必须	经营范围	最大长度: 500
├─ licenseExpiry	string	非必须	营业执照有效期	最大长度: 50
├─ licensePhoto	string	非必须	营业执照图片(OSS存储路径)	最大长度: 255
├─ terminalOriginCode	string	非必须	终端来源标志	最大长度: 50
├─ terminalOriginMemo	string	非必须	终端来源描述	最大长度: 200
success	boolean	必须	状态
traceId	string	必须	请求标识

YAPI 接口文档

(租户)主数据管理

总线配置

总线-终端修改

基本信息

请求参数

返回数据

总线-终端禁用

基本信息

请求参数

返回数据

点位管理API

单条点位新增

基本信息

请求参数

返回数据

多条点位新增

基本信息

请求参数

返回数据

点位列表查询

基本信息

请求参数

返回数据

点位更新

基本信息

请求参数

返回数据

点位详情查询

基本信息

请求参数

返回数据

渠道管理API

渠道下拉列表

基本信息

请求参数

返回数据

渠道关系名

基本信息

请求参数

返回数据

渠道子查父

基本信息

请求参数

返回数据

渠道树查询

基本信息

请求参数

返回数据

品类管理API

品类下拉列表(查询子品类)

基本信息

{

请求参数

返回数据

根据子品类code 获取品类层级关系名称

基本信息

简要描述

请求URL

参数

响应示例

请求参数

返回数据

获取品类树

基本信息

请求参数

返回数据

获取品类详情

基本信息

简要描述

请求URL

参数

响应示例 当品牌code无值

请求参数

返回数据

获取当前品类父品类

基本信息

请求参数

返回数据

品牌管理API

响应示例当品牌code无值

响应示例当品牌code无值

响应示例当品牌code无值