IconCreated with Sketch.

YAPI 接口文档

YApi
  • 公共分类
    • 查询品牌列表(默认查询一级品牌列表可传入品牌编码查询子品牌列表)
    • 查询品类列表(默认查询一级品类列表可传入品类编码查询子品类列表)
  • 临时任务
    • 下载模板
    • 临时任务列表页查询
    • 临时任务删除任务包
    • 临时任务包批量邀请触点下载模板
    • 临时任务包邀请触点
    • 临时任务截止状态修改【定时器维护接口】
    • 临时任务查看详情
    • 临时任务选择任务包
    • 删除临时任务
    • 发布临时任务
    • 导入
    • 已发布的临时任务追加任务包
    • 新建/更新临时任务基础信息
    • 新建临时任务--基础信息--关联项目下拉框查询
    • 新建临时任务--选择任务包 查询任务包列表
    • 更新临时任务libCode和截止时间
    • 更新临时任务步骤
    • 查询临时任务基础信息
    • 查询临时任务步骤
    • 查询已选中的任务包列表
    • 查询所有临时任务状态
    • 根据临时任务编码/名称模糊查询(列表页查询下拉框)
    • 根据项目编码/名称模糊查询(列表页查询下拉框)
    • 终止临时任务
    • 终止已经发布的某个临时任务包
  • 企业微信
    • 企业微信项目、月份选择过渡页
    • 终端计划列表内岗位下拉列表查询
    • 分析页-项目情况信息查询
    • 分析页-激活率查询
    • 终端计划列表
    • 激活详情-已激活列表查询
    • 任务执行情况模块列表查询
    • 激活详情-未激活列表查询
    • 任务执行情况模块详情及考题查询
    • 企业微信首页活跃信息查询
    • 企业微信活跃详情周维度
    • 企业微信活跃详情日维度
    • 获取活跃详情日维度状态下拉框
    • 企业微信终端详情
    • 获取当前月份所有自然周
  • PMS
    • 打印组织-项目编码缓存
    • 打印职员树缓存
    • 根据登陆信息获取职员下属列表
    • 根据登陆信息获取职员所在部门(包括子部门)
  • 任务包
    • 任务包-查询任务包列表
    • 任务包-查询项目名称编码下拉框
  • 执行计划管理
    • 执行计划管理-查询执行计划列表
    • 执行计划管理-查询项目编码名称下拉框
  • 费用管理
    • 任务账单-任务账单列表
  • 经营助手
    • 项目看板-月详情
    • 项目看板-获取大项目下拉选
    • 项目看板-获取大项目中子项目下拉选
    • 项目看板-获取客户下拉选
  • 激励模板
    • 新建激励模板
    • 更新激励模版
    • 查询激励模版详情
  • 销量管理
    • POS销量管理-项目名称编码下拉框
    • 销量管理列表
    • 销量管理导入模板
    • 销量管理上传
    • 销量管理导出
    • 详情页——获取销量上报项目信息
    • 详情页 —— 获取项目的激励模板
    • 详情页——顶部的统计和每周的统计
    • 详情页——销量管理分页列表
  • 任务执行报表
    • 任务执行excel导出
    • 任务执行列表
  • 项目执行配置
    • 考题配置——新建和更新考题配置
    • 考题配置——查询考题配置
    • 考题配置——考题导入模板
    • 考题配置——考题配置导出
    • 触点任务配置——保存任务库编码
    • 触点任务配置——查询任务库编码
    • 触点任务配置——校验项目是否结束
    • 项目执行配置-查询项目执行列表
    • 项目执行配置-项目名称编码下拉框
  • 项目管理
    • 终端计划-查询计划列表
    • 终端计划-项目名称编码下拉列表
    • 项目列表-查询项目列表
    • 项目列表-项目名称编码下拉列表
    • 项目详情-修改项目是否需要开启填写通过原因及是否必填标记
    • 项目详情-更新项目品牌配置
    • 项目详情-基础信息-选择项目所属组下拉框列表
    • 项目详情-基础信息-查询客户项目下拉列表
    • 项目详情-基础信息-查询项目信息
    • 项目详情-基础信息-查询项目步骤
    • 项目详情-基础信息-延续项目下拉列表查询
    • 项目详情-基础信息-项目类型下拉列表查询
    • 项目详情-任务配置-岗位配置查询
    • 项目详情-品牌配置-查询品牌树
    • 项目详情-品牌配置-查询项目的品牌配置
    • 项目详情-任务说明配置-招聘查询
    • 项目详情-任务说明配置-添加行业品类列表
    • 项目详情-任务说明配置-查询招聘标签
    • 终端计划-新建计划选择SKU弹窗列表
  • 执行管理
    • 任务审核报表-查询审核审核报表列表
    • 任务审核管理-查询任务审核列表
    • 任务审核管理-项目名称编码下拉框
    • 新建任务调查表 步骤2:项目编码查询
    • 新建任务调查表 步骤2填写调查表信息
    • 新建任务调查表-步骤1确定类型
    • 查询调查表第一步信息
    • 步骤条更新
  • 单品Sdk
    • 批量单品编码查询sku信息
    • 查询单品列表
    • 查询品牌树
    • 查询品类树
    • 根据单品编码查询该单品是否可用
    • 根据品牌编码向上查询其所有层级关系
    • 根据条形码查询该单品详情(导入时校验用)

经营者中台

经营者中台接口api文档

公共分类

查询品牌列表(默认查询一级品牌列表可传入品牌编码查询子品牌列表)

基本信息

Path: /basicdata/findBrandList

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 否 如果传值为空则查询一级品牌列表,如果传值不为空则查询传入的当前品牌的子品牌列表

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 23,
   "data": [
      {
         "brandCode": "brandXZ9JZDW9WF5",
         "brandName": "一级品牌",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "brand7728CGGGTZZ7",
         "brandName": "品牌1",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "brandF6FEXVA8S49",
         "brandName": "品牌",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproductXT5AK38BS2K",
         "brandName": "apple",
         "brandParCode": "",
         "imgLogo": ""
      },
      {
         "brandCode": "singleproduct3YU9M2ZW3SN",
         "brandName": "喜之郎",
         "brandParCode": "",
         "imgLogo": "brand/20211213/1_logo_314a37efaf2946a796c3ed974ff83203.png"
      },
      {
         "brandCode": "singleproduct3AH8BQE97P",
         "brandName": "A2",
         "brandParCode": "",
         "imgLogo": "brand/20211124/1_logo_fa131b3dc06648d8bef1830503e600db.jpg"
      },
      {
         "brandCode": "brand7M7J78BUD5",
         "brandName": "康师傅whtest22211",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct7PYUEY6AD5",
         "brandName": "康师傅whtest111",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct77QTSBCWD5",
         "brandName": "康师傅00001111",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct73V66SKUSD3",
         "brandName": "WZ品牌新增测试8",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct7XFPBLA7GD3",
         "brandName": "WZ品牌新增测试0",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct7F5LQXYZBD3",
         "brandName": "WZ品牌新增测试5",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct7KQ8SZUW2D3",
         "brandName": "喜之郎777",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct7TU7LDJYRD3",
         "brandName": "喜之郎666",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproduct7B44U478D3",
         "brandName": "WZ品牌新增测试4",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproductPDBJMB2PKTT",
         "brandName": "WZ品牌修改测试2",
         "brandParCode": "",
         "imgLogo": ""
      },
      {
         "brandCode": "singleproductPN9C9F4KTTT",
         "brandName": "WZ品牌新增测试1",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproductFF7Z6LMNNLL",
         "brandName": "  的电都嘎嘎嘎",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproductF5TQ6SZET2K",
         "brandName": "     解决一切问题的总钥匙。中央关于党的百年奋斗重大成就和历史经验的决议》强调,必须实现",
         "brandParCode": "",
         "imgLogo": null
      },
      {
         "brandCode": "singleproductFGBBPL4RZ2K",
         "brandName": "男装",
         "brandParCode": "",
         "imgLogo": "brand/20211223/1_logo_4f7eb351b2bf415aa78f7a447265447b.png"
      },
      {
         "brandCode": "singleproductFLTLRUNKT2K",
         "brandName": "女装",
         "brandParCode": "",
         "imgLogo": "brand/20211224/1_logo_28bb2c5f2ec24edbae8404bce8d0d517.png"
      },
      {
         "brandCode": "singleproductFLK5RJWZN2K",
         "brandName": "食品",
         "brandParCode": null,
         "imgLogo": null
      },
      {
         "brandCode": "singleproductKFUFPVMYD",
         "brandName": "A302",
         "brandParCode": "",
         "imgLogo": "brand/20211213/1_logo_34ae80a6c5554e6fbe30059bf6585919.jpg"
      }
   ],
   "success": true
}

查询品类列表(默认查询一级品类列表可传入品类编码查询子品类列表)

基本信息

Path: /basicdata/findCategoryList

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 否 如果传值为空则查询一级品类列表,如果传值不为空则查询传入的当前品类的子品类列表

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 11,
   "data": [
      {
         "categoryCode": "STC000FA5K4NSVCTZ7",
         "categoryName": "6",
         "categoryParCode": null,
         "sort": "1000",
         "isHave": "true"
      },
      {
         "categoryCode": "STC000X6DKKLAX8Z7",
         "categoryName": "5",
         "categoryParCode": null,
         "sort": "999",
         "isHave": "false"
      },
      {
         "categoryCode": "STC000XWPMGBMZCZ7",
         "categoryName": "2",
         "categoryParCode": null,
         "sort": "998",
         "isHave": "false"
      },
      {
         "categoryCode": "STC000X6M8A3WW5Z7",
         "categoryName": "4",
         "categoryParCode": null,
         "sort": "997",
         "isHave": "false"
      },
      {
         "categoryCode": "STC000XWGNHMTHAZ7",
         "categoryName": "1",
         "categoryParCode": null,
         "sort": "996",
         "isHave": "true"
      },
      {
         "categoryCode": "STC000X6XLUGNMSZ7",
         "categoryName": "3",
         "categoryParCode": null,
         "sort": "995",
         "isHave": "false"
      },
      {
         "categoryCode": "category77JEGL8KGZZ7",
         "categoryName": "品类1",
         "categoryParCode": null,
         "sort": "994",
         "isHave": "false"
      },
      {
         "categoryCode": "categoryF6F73J73K49",
         "categoryName": "1品类",
         "categoryParCode": null,
         "sort": "993",
         "isHave": "false"
      },
      {
         "categoryCode": "categoryF2LPFZJQW49",
         "categoryName": "一级品类",
         "categoryParCode": null,
         "sort": "992",
         "isHave": "true"
      },
      {
         "categoryCode": "STC000FHPEHL25WRP",
         "categoryName": "三级品类1",
         "categoryParCode": null,
         "sort": "991",
         "isHave": "false"
      },
      {
         "categoryCode": "STC000FZ59SHJGDRP",
         "categoryName": "三级品类2",
         "categoryParCode": null,
         "sort": "990",
         "isHave": "true"
      }
   ],
   "success": true
}

临时任务

下载模板

基本信息

Path: /api/lhdg/v2/task/export/template

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorMessagestring非必须
errorCodestring非必须
datastring非必须模板绝对路径

临时任务列表页查询

基本信息

Path: /api/lhdg/v2/task/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 否 临时任务编码
projectCode 否 项目编码
status 否 状态
creator 否 创建人姓名
page 否 分页
size 否 分页

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ taskCodestring非必须临时任务编码
├─ taskNamestring非必须临时任务名称
├─ descriptionstring非必须临时任务描述
├─ statusstring非必须状态
├─ projectCodestring非必须项目编码
├─ projectNamestring非必须项目名称
├─ creatorstring非必须创建人
├─ memostring非必须备注
├─ updatorstring非必须更新人
├─ updateTimestring非必须更新时间
├─ libCodestring必须任务库编码
errorCodestring非必须
errorMessagestring非必须

临时任务删除任务包

基本信息

Path: /api/lhdg/v2/task/delete/workpackage

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
taskCodestring必须临时任务编码
workPackageCodesstring []必须

item 类型: string

├─ 非必须工作包编码

返回数据

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

临时任务包批量邀请触点下载模板

基本信息

Path: /api/lhdg/v2/task/export/pgtemplate

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 是 临时任务编码
flag 是 是否具有终止权限的标识

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
datastring非必须绝对路径
errorCodestring非必须
errorMessagestring非必须

临时任务包邀请触点

基本信息

Path: /api/lhdg/v2/task/import/pg

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
file text 是 文件
taskCode text 是 临时任务编码
flag text 是 是否具有终止权限的标识

临时任务截止状态修改【定时器维护接口】

基本信息

Path: /task/expireTaskWork

Method: GET

接口描述:




请求参数

Query

参数名称 是否必须 示例 备注
now 否 "2020-03-17" 截止日期【修改小于截止日期不包含等于截止日期】
taskCode 否 "TAS7VAZ7982MG9" 任务编码【如果填了任务编码,需要填写截止日期】

返回数据

名称类型是否必须默认值备注其他信息
errMsgstring必须错误信息
successstring必须成功标识
errorCodestring必须错误编码

临时任务查看详情

基本信息

Path: /api/lhdg/v2/task/detail/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 是 临时任务编码
flag 是 是否具有终止权限的标识
page 否 分页
size 否 分页

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ workPackageCodestring非必须临时任务包编码
├─ projectNamestring非必须项目名称
├─ projectCodestring非必须项目编码
├─ terminalNamestring非必须终端名称
├─ terminalCodestring非必须终端编码
├─ brandStoreNamestring非必须品牌终端名称
├─ brandStoreCodestring非必须品牌终端编码
├─ provincestring非必须省
├─ citystring非必须市
├─ areastring非必须区
├─ statusstring非必须状态
├─ empPkstring非必须触点编码
├─ pgNamestring非必须触点姓名
├─ createTimestring非必须领取时间
├─ updatorNamestring非必须最后更新人
├─ updateTimestring非必须最后更新时间
errorCodestring非必须
errorMessagestring非必须

临时任务选择任务包

基本信息

Path: /api/lhdg/v2/task/update/workpackage

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
taskCodestring非必须临时任务编码
workPackageCodesstring []非必须

item 类型: string

├─ 非必须工作包编码

返回数据

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

删除临时任务

基本信息

Path: /api/lhdg/v2/task/delete

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
taskCode text 是 临时任务编码

返回数据

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

发布临时任务

基本信息

Path: /api/lhdg/v2/task/publish

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 是 临时任务编码

返回数据

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

导入

基本信息

Path: /api/lhdg/v2/task/import

Method: POST

接口描述:

请求参数

Headers

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

Body

参数名称 参数类型 是否必须 示例 备注
file file 是 文件
taskCode text 是 临时任务编码

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
dataobject非必须
├─ addNumnumber非必须正常数据数量
├─ allNumnumber非必须数据总数
├─ failNumnumber非必须异常数据数量
├─ absoluteUrlstring非必须下载绝对路径
├─ isSuccessboolean非必须是否导入成功
├─ errTypestring非必须异常类型
errCodestring非必须
errMessagestring非必须

已发布的临时任务追加任务包

基本信息

Path: /api/lhdg/v2/task/publish/add

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
taskCodestring必须临时任务编码
listobject []必须

item 类型: object

├─ packageCodestring必须任务包编码
├─ projectCodestring必须项目编码
├─ projectNamestring必须项目名称
├─ terminalCodestring必须终端编码
├─ terminalNamestring必须终端名称

返回数据

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

新建/更新临时任务基础信息

基本信息

Path: /api/lhdg/v2/task/create/basic

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
taskNamestring必须临时任务名称
taskCodestring非必须临时任务编码
descriptionstring必须临时任务描述
requirementstring必须临时任务要求
projectCodestring必须项目编码

返回数据

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

新建临时任务--基础信息--关联项目下拉框查询

基本信息

Path: /api/lhdg/v2/task/create/projectList

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 否 项目编码/名称

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ namestring非必须名称
├─ codestring非必须编码
errorCodestring非必须
errorMessagestring非必须

新建临时任务--选择任务包 查询任务包列表

基本信息

Path: /api/lhdg/v2/task/query/workpackage

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 0 分页
size 否 10 分页
workPackageCode 否 任务包编码
terminalCode 否 终端名称/编码
empPk 否 触点姓名/编码
provinceCode 否 省
cityCode 否 市
areaCode 否 区
taskCode 是 临时任务编码

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorMessagestring非必须
errorCodestring非必须
dataobject非必须
├─ selectedCountnumber非必须已选中任务包数量
├─ listobject []非必须

item 类型: object

├─ workPackageCodestring非必须工作包编码
├─ terminalCodestring非必须终端编码
├─ terminalNamestring非必须终端名称
├─ brandStoreCodestring非必须品牌终端编码
├─ brandStoreNamestring非必须品牌终端名称
├─ provincestring非必须省
├─ citystring非必须市
├─ areastring非必须区
├─ statusstring非必须领取状态
├─ selectedboolean非必须是否被选中,true表示已选中

更新临时任务libCode和截止时间

基本信息

Path: /api/lhdg/v2/task/update/libcode

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
taskCodestring必须临时任务编码
libCodestring必须libCode
taskEndDatestring非必须配置的临时任务最晚的截止时间

返回数据

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

更新临时任务步骤

基本信息

Path: /api/lhdg/v2/task/update/step

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
taskCodestring必须临时任务编码
stepnumber必须步骤

返回数据

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

查询临时任务基础信息

基本信息

Path: /api/lhdg/v2/task/query/basic

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 是 临时任务编码

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
dataobject非必须
├─ taskNamestring非必须临时任务名称
├─ taskCodestring非必须临时任务编码
├─ descriptionstring非必须临时任务描述
├─ requirementstring非必须临时任务要求
├─ projectCodestring非必须项目编码
├─ projectNamestring非必须项目名称
errorCodestring非必须
errorMessagestring非必须

查询临时任务步骤

基本信息

Path: /api/lhdg/v2/task/query/step

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 是 临时任务编码

返回数据

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

查询已选中的任务包列表

基本信息

Path: /api/lhdg/v2/task/workpackage/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 是 临时任务编码
page 否 分页
size 否 分页

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
totalnumber非必须
dataobject []非必须总数

item 类型: object

├─ workPackageCodestring非必须工作包编码
├─ positionCodestring非必须任务编码
├─ positionNamestring非必须任务名称
├─ terminalCodestring非必须终端编码
├─ terminalNamestring非必须终端名称
├─ brandStoreCodestring非必须品牌终端编码
├─ brandStoreNamestring非必须品牌终端名称
├─ provincestring非必须省
├─ citystring非必须市
├─ areastring非必须区
├─ statusstring非必须招聘状态
errorCodestring非必须
errorMessagestring非必须

查询所有临时任务状态

基本信息

Path: /api/lhdg/v2/task/queryAllStatus

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ codestring非必须编码
├─ valuestring非必须值
errorCodestring非必须
errorMessagestring非必须

根据临时任务编码/名称模糊查询(列表页查询下拉框)

基本信息

Path: /api/lhdg/v2/task/vagueTask

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
taskCode 否 临时任务编码/名称

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ namestring非必须名称
├─ codestring非必须编码
errorCodestring非必须
errorMessagestring非必须

根据项目编码/名称模糊查询(列表页查询下拉框)

基本信息

Path: /api/lhdg/v2/task/vagueProject

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 否 项目编码/名称

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ namestring非必须名称
├─ codestring非必须编码
errorCodestring非必须
errorMessagestring非必须

终止临时任务

基本信息

Path: /api/lhdg/v2/task/termination

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
taskCodestring必须临时任务编码
memostring必须终止原因

返回数据

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

终止已经发布的某个临时任务包

基本信息

Path: /api/lhdg/v2/task/termination/workpackage

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
workPackageCode text 是 临时任务包编码

返回数据

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

企业微信

企业微信项目、月份选择过渡页

基本信息

Path: /api/weekly/v2/salesReport/index/projectList

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 now:实时动态,history:历史纪录

返回数据

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

item 类型: object

├─ monthstring非必须月份
├─ projectListobject []非必须

item 类型: object

├─ codestring非必须项目编码
├─ namestring非必须名称
├─ monthstring非必须月份
traceIdstring必须

终端计划列表内岗位下拉列表查询

基本信息

Path: /api/weekly/v2/sales/report/positionList

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 项目编码
month 是 项目所属年月

返回数据

{
   "success": true,
   "data": [
      {
         "positionCode": "POSPH79DG644BK",
         "positionName": "金佰利【全品】"
      }
   ],
   "traceId": "f0d99ac8bb89cebfb65877797b4a5ac7"
}

分析页-项目情况信息查询

基本信息

Path: /api/weekly/v2/sales/report/projectPlanInfo

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 WIKBCGX2204033500 项目编码
month 是 2022-04 年月

返回数据

{
  "success": true,
  "data": {
     /*项目编码*/
    "projectCode": "WIKBCGX2204033500",
     /*项目名称*/
    "projectName": "projectName",
     /*项目所属年月*/
    "month": "2022-04",
     /*项目开始日期*/
    "startDate": "2022-04-01",
     /*项目结束日期*/
    "endDate": "2022-04-30",
     /*总计划终端数*/
    "terminalNum": 37,
     /*更新时间*/
    "updateTime": "2022/04/24 15:00"
  },
  "traceId": "0147ed6b1e85243fedf4ceaf987e1f0a"
}

分析页-激活率查询

基本信息

Path: /api/weekly/v2/sales/report/activationRate

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 WIKBCGX2204033500 项目编码
month 是 2022-04 年月

返回数据

{
  "success": true,
  "data": {
    /*项目编码*/
    "projectCode": "WIKBCGX2204033500",
    /*总终端计划数*/
    "terminalPlanSumCount": 37,
    /*已激活计划数*/
    "activeTerminalPlanCount": 37,
    /*未激活计划数*/
    "noActiveTerminalPlanCount": 0,
    /*激活率*/
    "activationRate": "100%",
    /*历史周激活率*/
    "hisWeekActivationRateList": [
      {
        /*项目编码*/
        "projectCode": "WIKBCGX2204033500",
        /*周开始日期*/
        "startDate": "2022-04-01",
        /*周结束日期*/
        "endDate": "2022-04-03",
        /*所属周*/
        "weekOfMonth": 1,
        /*当周有效终端计划数*/
        "weekTerminalPlanNum": 8,
        /*当周新增有效激活终端计划数*/
        "newWeekTerminalPlanNum": 8,
        /*历史激活有效终端计划数*/
        "historyTerminalPlanNum": 0
      },
      {
        "projectCode": "WIKBCGX2204033500",
        "startDate": "2022-04-04",
        "endDate": "2022-04-10",
        "weekOfMonth": 2,
        "weekTerminalPlanNum": 2,
        "newWeekTerminalPlanNum": 2,
        "historyTerminalPlanNum": 8
      },
      {
        "projectCode": "WIKBCGX2204033500",
        "startDate": "2022-04-11",
        "endDate": "2022-04-17",
        "weekOfMonth": 3,
        "weekTerminalPlanNum": 2,
        "newWeekTerminalPlanNum": 2,
        "historyTerminalPlanNum": 10
      }
    ]
  },
  "traceId": "b1e145a56fb7973791c2fcb8b8d93479"
}

终端计划列表

基本信息

Path: /api/weekly/v2/sales/report/terminalPlanList

Method: POST

接口描述:

请求参数

Headers

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

Body

{
    // 分页
	"pageNumber" : 0,
	"pageSize" : 10,
	// 项目编码
	"projectCode" : "WIKBCGX2204033500",
	// 项目年月
	"month" : "2022-04",
	// 计划状态
	"status" : "ACTIVATED",
	// 计划类型(新增/原计划 NEW/ORIGN)
	"type" : "NEW",
	// 岗位编码
	"postionCode" : "POSPH79DG644BK",
	// 省编码
	"province" : "370611",
	// 市编码
	"city" : "370611",
	// 区编码
	"district" : "370611",
	// 终端名称
	"terminalName" : "中百佳乐家潍坊寒亭店"
}

返回数据

{
	"success": true,
	"data": [
		{
            // 项目编码
			"projectCode": "WIKBCGX2204033500",
            // 计划编码
			"planCode": "PLANFA4657JK6G8",
            // 计划状态
			"status": "ACTIVATED",
            // 计划类型(新增为NEW/原计划)
			"type": "NEW",
            // 岗位编码
			"positionCode": "POSPH79DG644BK",
            // 岗位名称
			"positionName": "金佰利【全品】",
            // 省
			"province": "山东省",
            // 市
			"city": "潍坊市",
            // 区
			"district": "寒亭区",
            // 终端编码
			"orgTerminalCode": "3707010310041054173003",
            // 终端名称
			"orgTerminalName": "中百佳乐家潍坊寒亭店",
            // 计划发布时间
			"publishTime": "2022-04-23 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "潍坊市",
			"district": "奎文区",
			"orgTerminalCode": "3707010513171379233002",
			"orgTerminalName": "佳乐家潍坊宝通街与金马路交叉口西南店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "威海市",
			"district": "文登区",
			"orgTerminalCode": "3710810010041046003472",
			"orgTerminalName": "家家悦威海文登店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "威海市",
			"district": "环翠区",
			"orgTerminalCode": "3710000010041046003466",
			"orgTerminalName": "家家悦威海长江街店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "潍坊市",
			"district": "青州市",
			"orgTerminalCode": "3707810010031021176944",
			"orgTerminalName": "大润发青州店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "潍坊市",
			"district": "奎文区",
			"orgTerminalCode": "3707010010041061126817",
			"orgTerminalName": "佳乐家谷德店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "潍坊市",
			"district": "潍城区",
			"orgTerminalCode": "3707010213171379232769",
			"orgTerminalName": "佳乐家潍坊东风西街店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "烟台市",
			"district": "福山区",
			"orgTerminalCode": "3706010010031021188192",
			"orgTerminalName": "大润发烟台福海路店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "烟台市",
			"district": "芝罘区",
			"orgTerminalCode": "3706000010031021003384",
			"orgTerminalName": "大润发烟台南大街店",
			"publishTime": "2022-03-25 16:50"
		},
		{
			"projectCode": "WIKBCGX2204033500",
			"month": null,
			"status": "ACTIVATED",
			"type": null,
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"province": "山东省",
			"city": "烟台市",
			"district": "福山区",
			"orgTerminalCode": "3706010010031021138298",
			"orgTerminalName": "大润发烟台衡山路店",
			"publishTime": "2022-03-25 16:50"
		}
	],
	"traceId": "b134ac450499f2f6bf3c32321b296269",
	"total": 37
}

激活详情-已激活列表查询

基本信息

Path: /api/weekly/v2/sales/report/activationDetail

Method: POST

接口描述:

请求参数

Headers

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

Body

{
    // 分页
	"pageNumber" : 0,
	"pageSize" : 10,
    // 项目编码
	"projectCode" : "WIKBCGX2204033500",
    // 项目所属月分
	"month" : "2022-04",
	// 计划状态
	"status" : "ACTIVATED",
	// 计划类型(新增/原计划 NEW/ORIGN)
	"type" : "NEW",
	// 省
	"province" : "山东省",
	// 市
	"city" : "潍坊市",
	// 区
	"district" : "寒亭区",
}

返回数据

{
	"success": true,
	"data": [
		{
          // 计划编码
          "planCode": "PLANXF7TQVCJ9MBK",
          // 岗位编码
          "positionCode": "POSPH79DG644BK",
          // 岗位
          "positionName": "金佰利【全品】",
          // 终端编码
          "orgTerminalCode": "3705010010041061016740",
          // 终端名称
          "orgTerminalName": "银座东营河口店",
          // 发布时间
          "publishTime": "2022-03-25 16:50",
          // 激活时间
          "activationTime": "2022-04-11 16:02",
          // 销量目标
          "planSales": 11500,
          // 单位
		  "unit": "元",
          // 类型(新增为NEW,原计划为空)
          "type": null,
          // 计划状态
          "status" : "ACTIVATED",
		  "province": "山东省",
		  "city": "东营市",
		  "district": "河口区"
        },
		{
			"planCode": "PLANXXJHL5H3JTBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3701010010041046047428",
			"orgTerminalName": "家家悦济南二环西路店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-11 15:02",
			"planSales": 12200,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXFXTKAEAWBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3703010010041400238631",
			"orgTerminalName": "家家悦淄博金晶大道店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-07 18:32",
			"planSales": 17160,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXX6PCYDJSBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3707010010041061126817",
			"orgTerminalName": "佳乐家谷德店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-06 08:02",
			"planSales": 53300,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXXUJ7ML5JBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3710010010041061043142",
			"orgTerminalName": "家家悦威海东发园林店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-03 10:02",
			"planSales": 15000,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXFU44J69CBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3702820010041046144199",
			"orgTerminalName": "家家悦即墨宝龙店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-02 11:03",
			"planSales": 15620,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXX4TFSV9FBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3710830010041046003483",
			"orgTerminalName": "家家悦乳山金丰店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-01 15:35",
			"planSales": 20000,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXFWT2VMMNBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3703010010041046092194",
			"orgTerminalName": "家家悦淄博SM广场店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-01 11:34",
			"planSales": 32450,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXFPS8SAP3BK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3702000010041046003328",
			"orgTerminalName": "家家悦青岛南京路店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-01 11:06",
			"planSales": 27400,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXX84LSJK2BK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3706010010031021138298",
			"orgTerminalName": "大润发烟台衡山路店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-01 11:06",
			"planSales": 30000,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		}
	],
	"traceId": "074be2847c739ac4b23ad26e953cbfd4",
	"total": 102
}

任务执行情况模块列表查询

基本信息

Path: /api/weekly/v2/sales/report/taskPerformInfo

Method: POST

接口描述:

请求参数

Headers

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

Body

{
    // 项目编码
	"projectCode" : "WIKBCGX2204033500",
    // 项目所属月份
	"month" : "2022-04",
	// 触点编码(传空查全部 不为空查指定触点编码的数据)
	"userCode" : "",
	// 终端编码
	"orgTerminalCode" : "3707010310041054173003",
    // 计划编码
    "planCode" : "",
    // 日期
    "date" : ""
}

返回数据

{
    "success":true,
    "data":{
        // 项目编码
        "projectCode":"WIKBCGX2204033500",
        // 终端编码
        "orgTerminalCode":"3707010310041054173003",
        // 终端名称
        "orgTerminalName":"中百佳乐家潍坊寒亭店",
        // 项目所属月份
        "month":"2022-04",
        // 省
        "province":"山东省",
        // 市
        "city":"潍坊市",
        // 区
        "district":"寒亭区",
        // 岗位
        "positionName":"金佰利【全品】",
        // 模块列表
        "data":[
            {
                // 任务模块编码
                "taskCode":"CLSB",
                // 任务模块名称
                "taskName":"陈列上报",
                // 任务数量
                "taskCount":8
            },
            {
                "taskCode":"XLSB",
                "taskName":"销量上报",
                "taskCount":4
            },
            {
                "taskCode":"JSZP",
                "taskName":"结束照片",
                "taskCount":4
            },
            {
                "taskCode":"KSZP",
                "taskName":"开始照片",
                "taskCount":8
            }
        ]
    },
    "traceId":"fb367ae8b63f0c07e51fc8faa6263711"
}

激活详情-未激活列表查询

基本信息

Path: /api/weekly/v2/sales/report/notActivationDetail

Method: POST

接口描述:

请求参数

Headers

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

Body

{
    // 分页
	"pageNumber" : 0,
	"pageSize" : 10,
    // 项目编码
	"projectCode" : "WIKBCGX2204033500",
    // 项目所属月分
	"month" : "2022-04",
	// 计划状态
	"status" : "ACTIVATED",
	// 计划类型(新增/原计划 NEW/ORIGN)
	"type" : "NEW",
	// 省
	"province" : "山东省",
	// 市
	"city" : "潍坊市",
	// 区
	"district" : "寒亭区",
}

返回数据

{
	"success": true,
	"data": [
		{
            // 计划编码
			"planCode": "PLANXXB7TQ867XBK",
            // 岗位编码
			"positionCode": "POSPH79DG644BK",
            // 岗位
			"positionName": "金佰利【全品】",
            // 终端编码
			"orgTerminalCode": "3707010310041054173003",
            // 终端名称
			"orgTerminalName": "中百佳乐家潍坊寒亭店",
            // 发布时间
			"publishTime": "2022-04-25 16:50",
            // 激活时间
			"activationTime": "2022-04-01 10:37",
            // 销量目标
			"planSales": 32120,
            // 元
			"unit": "元",
            // 类型(新增为NEW,原计划为空)
			"type": "NEW",
            // 计划状态
			"status": "CANCELLED",
			"province": "山东省",
			"city": "东营市",
			"district": "河口区",
		},
		{
			"planCode": "PLANXXHGPPWF4BK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3707010513171379233002",
			"orgTerminalName": "佳乐家潍坊宝通街与金马路交叉口西南店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-03-28 13:32",
			"planSales": 31240,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXXHLR333PBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3710810010041046003472",
			"orgTerminalName": "家家悦威海文登店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-03-28 12:03",
			"planSales": 17200,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXXXXLMFV5BK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3710000010041046003466",
			"orgTerminalName": "家家悦威海长江街店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-03-28 13:33",
			"planSales": 28600,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXX3WSETLCBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3707810010031021176944",
			"orgTerminalName": "大润发青州店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-03-28 11:08",
			"planSales": 36000,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXX6PCYDJSBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3707010010041061126817",
			"orgTerminalName": "佳乐家谷德店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-06 08:02",
			"planSales": 53300,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXXQ4TWCMWBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3707010213171379232769",
			"orgTerminalName": "佳乐家潍坊东风西街店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-03-28 21:03",
			"planSales": 25190,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXX36VKE7LBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3706010010031021188192",
			"orgTerminalName": "大润发烟台福海路店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-03-31 12:06",
			"planSales": 27500,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXXBEDPVTTBK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3706000010031021003384",
			"orgTerminalName": "大润发烟台南大街店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-03-28 11:34",
			"planSales": 40000,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		},
		{
			"planCode": "PLANXX84LSJK2BK",
			"positionCode": "POSPH79DG644BK",
			"positionName": "金佰利【全品】",
			"orgTerminalCode": "3706010010031021138298",
			"orgTerminalName": "大润发烟台衡山路店",
			"publishTime": "2022-03-25 16:50",
			"activationTime": "2022-04-01 11:06",
			"planSales": 30000,
			"planSalesStr": null,
			"unit": "元",
			"type": null,
			"status": "ACTIVATED"
		}
	],
	"traceId": "2fc11650deb426932e25e41b736036bc",
	"total": 37
}

任务执行情况模块详情及考题查询

基本信息

Path: /api/weekly/v2/sales/report/taskPerformDetail

Method: POST

接口描述:

请求参数

Headers

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

Body

{
    // 项目编码
	"projectCode" : "WIKBCGX2204033500",
    // 项目所属月份
	"month" : "2022-04",
	// 触点编码(传空查全部 不为空查指定触点编码的数据)
	"userCode" : "",
	// 终端编码
	"orgTerminalCode" : "3707010310041054173003",
	// 模块编码
	"taskCode" : "CLSB",
    // 计划编码
    "planCode" : "",
    // 日期
    "date" : ""
}

返回数据

{
	"success": true,
	"data": [
		{
		    // 子任务名称
			"subTaskTitle": "好奇货架陈列照",
		    // 提报时间
			"reportTime": "2022-04-02 08:33:49",
		    // 审核时间
			"auditTime": "2022-04-09 11:30:13",
		    // 触点编码
			"userCode": "1000170557",
		    // 触点姓名
			"userName": "张三",
		    // 审核人
			"auditorName": "系统审核",
		    // 考题列表
            "data":[
                {
                    // 问题类型(0:问答 1:单选 2:多选 3:图片)
                    "itemType": "2",
                    // 问题
                    "question": "",
                    // 答案 (多选题会有多个答案 其他题只有一个答案)
                    "answer": [
                        "aaa",
                        "bbb",
                        "ccc"  
                    ],
                    // 图片题示例图片
                    "exampleImg" : "图片下载地址"
                }
            ]
		},
		{
			"subTaskTitle": "高洁丝货架陈列照",
			"reportTime": "2022-04-02 08:34:06",
			"auditTime": "2022-04-09 11:30:13",
			"userCode": "1000170557",
			"userName": "张三",
			"auditorName": "系统审核",
			"data": null
		},
		{
			"subTaskTitle": "好奇货架陈列照",
			"reportTime": "2022-04-04 08:00:36",
			"auditTime": "2022-04-11 10:23:10",
			"userCode": "1000170557",
			"userName": "张三",
			"auditorName": "系统审核",
			"data": null
		},
		{
			"subTaskTitle": "高洁丝货架陈列照",
			"reportTime": "2022-04-04 08:00:56",
			"auditTime": "2022-04-11 10:23:10",
			"userCode": "1000170557",
			"userName": "张三",
			"auditorName": "系统审核",
			"data": null
		},
		{
			"subTaskTitle": "好奇货架陈列照",
			"reportTime": "2022-04-09 14:24:36",
			"auditTime": "2022-04-16 10:04:40",
			"userCode": "1000170557",
			"userName": "张三",
			"auditorName": "系统审核",
			"data": null
		},
		{
			"subTaskTitle": "高洁丝货架陈列照",
			"reportTime": "2022-04-09 14:24:57",
			"auditTime": "2022-04-16 10:04:40",
			"userCode": "1000170557",
			"userName": "张三",
			"auditorName": "系统审核",
			"data": null
		},
		{
			"subTaskTitle": "好奇货架陈列照",
			"reportTime": "2022-04-13 14:18:09",
			"auditTime": "2022-04-20 10:01:07",
			"userCode": "1000170557",
			"userName": "张三",
			"auditorName": "系统审核",
			"data": null
		},
		{
			"subTaskTitle": "高洁丝货架陈列照",
			"reportTime": "2022-04-13 14:18:44",
			"auditTime": "2022-04-20 10:01:07",
			"userCode": "1000170557",
			"userName": "张三",
			"auditorName": "系统审核",
			"data": null
		}
	],
	"traceId": "8de1d472869f667617a7fd4b78ce1541"
}

企业微信首页活跃信息查询

基本信息

Path: /api/weekly/v2/salesReport/index/att

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 now 类型,用于区分是历史记录还是实时动态 history : now
projectCode 是 WIDMHGX2204035800 项目编码
month 是 2022-04 月份

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
dataobject非必须
├─ attTodaynumber非必须今日活跃次数 (只有实时分析页面才有)
├─ attMonthnumber非必须计划总活跃次数 (只有历史分析页面才有)
├─ attSumnumber非必须累计活跃获取
├─ attPassSumnumber非必须累计活跃合格
├─ attPassRatenumber非必须活跃合格率
├─ attWeekobject []非必须活跃周统计

item 类型: object

├─ attPlanWeeknumber非必须周计划活跃次数
├─ attWeeknumber非必须周实际活跃次数
├─ attPassWeeknumber非必须周实际活跃合格次数
├─ weekNonumber非必须第几周
├─ timestring非必须刷新时间
traceIdstring非必须

企业微信活跃详情周维度

基本信息

Path: /api/weekly/v2/salesReport/week/att

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 WIDMHGX2204035800 项目编码
type 是 now 类型,用于区分是历史记录还是实时动态 history : now
weekNo 否 第几周 不填默认查询请求时间所在的那一周
month 是 2022-04 月份

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
dataobject非必须
├─ weekNonumber非必须第几周
├─ projectCodestring非必须项目编码
├─ weekPlanAttnumber非必须周计划活跃次数
├─ weekAttnumber非必须周获取活跃次数
├─ weekPassAttnumber非必须周实际活跃合格次数
├─ weekFailAttnumber非必须周实际活跃异常次数
├─ weekFailEndAttnumber非必须周实际活跃异常--未结束
├─ weekFailGpsAttnumber非必须周实际活跃异常--位置异常
├─ weekPassAttRatenumber非必须周活跃合格率
├─ dayAttobject []非必须每日活跃明细

item 类型: object

├─ datestring必须日期
├─ dayAttnumber必须日活跃获取次数
├─ dayPassAttnumber必须日活跃合格次数
traceIdstring非必须

企业微信活跃详情日维度

基本信息

Path: /api/weekly/v2/salesReport/day/att

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 项目编码 项目编码
date 是 日期 日期
status 是 状态(活跃合格、活跃异常、活跃中) 状态(活跃合格、活跃异常、活跃中)
province 是 省 省
city 是 市 市
area 是 区 区
terminalName 是 终端名称 终端名称

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
dataobject非必须
├─ attCountnumber非必须活跃获取次数
├─ attPassCountnumber非必须活跃合格次数
├─ pgAttListobject []非必须触点活跃详情

item 类型: object

├─ pgNamestring必须触点姓名
├─ pgCodestring必须触点编码
├─ terminalNamestring必须终端名称
├─ terminalCodestring必须终端编码
├─ attStartstring必须任务开始时间
├─ attEndstring,null必须任务结束时间
├─ posNamestring必须任务名称
├─ posCodestring必须任务编码
├─ statusstring必须状态
├─ startStatusnumber必须上班卡定位是否异常
├─ endStatusnumber,null必须下班卡定位是否异常
traceIdstring非必须

获取活跃详情日维度状态下拉框

基本信息

Path: /api/weekly/v2/salesReport/day/attStatus

Method: GET

接口描述:

请求参数

返回数据

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

item 类型: object

├─ codestring必须编码
├─ valuestring必须值
traceIdstring非必须

企业微信终端详情

基本信息

Path: /api/weekly/v2/salesReport/plan/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
planCode 是 PLANXPDDXAEKZCBK 计划编码
type 是 now 类型,用于区分是历史记录还是实时动态 history : now

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
dataobject非必须
├─ terminalNamestring非必须终端名称
├─ provincestring非必须省
├─ citystring非必须市
├─ areastring非必须区
├─ positionNamestring非必须任务名称
├─ planSalesstring非必须销量目标
├─ historicalSalesstring非必须上月销量
├─ publishTimestring非必须计划发布时间
├─ cancelTimestring非必须计划取消时间
├─ planPgCntnumber非必须计划触点人数
├─ statusstring非必须状态,已激活 未激活
├─ batchCodestring非必须批次编码 用于查询考勤信息
├─ planDaysnumber非必须计划执行天数
├─ attCountnumber非必须活跃获取次数
├─ attPassCountnumber非必须活跃合格次数
├─ pgListobject []非必须触点招聘信息

item 类型: object

├─ namestring非必须触点姓名
├─ timestring非必须领取时间
├─ pgAttListobject []非必须

item 类型: object

├─ datestring非必须日期
├─ startTimestring非必须上班打卡时间
├─ endTimestring,null非必须下班打卡时间
├─ namestring非必须姓名
├─ startStatusnumber非必须上班打卡定位是否异常
├─ endStatusnumber,null非必须下班打卡定位是否异常
├─ statusnull非必须状态
traceIdstring非必须

获取当前月份所有自然周

基本信息

Path: /api/weekly/v2/salesReport/week/getWeeks

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
month 是 2022-04 月份

返回数据

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

item 类型: object

├─ codenumber必须第几周
├─ valuestring必须值
traceIdstring非必须

PMS

打印组织-项目编码缓存

基本信息

Path: /api/pms/v1/test/printStructureProjectCache

Method: GET

接口描述:

请求参数

打印职员树缓存

基本信息

Path: /api/pms/v1/test/printJurisdictionUserCache

Method: GET

接口描述:

请求参数

根据登陆信息获取职员下属列表

基本信息

Path: /api/pms/v1/jurisdiction/sonstaff

Method: GET

接口描述:

请求参数

根据登陆信息获取职员所在部门(包括子部门)

基本信息

Path: /api/pms/v1/dept/sondept

Method: GET

接口描述:

请求参数

任务包

任务包-查询任务包列表

基本信息

Path: /api/lhdg/v2/workpackage/list/find

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 是 页数
pageSize 是 页大小
projectCode 否 项目编码
projectName 否 项目名称
terminalParam 否 系统终端名称
provinceName 否 省
cityName 否 市
region 否 区
statusCode 否 状态编码
channelName 否 通路类别
operatorPG 否 经营者(触点)
operatorSite 否 经营者(场)
operatorCommunicate 否 经营者(沟通)
posParam 否 任务
workPackageCode 否 任务包编码
pgCode 否 触点编码
pgName 否 触点姓名
brandStoreParam 否 品牌终端名称
selectMonthStart 否 项目执行月份
selectMonthEnd 否 项目执行月份

任务包-查询项目名称编码下拉框

基本信息

Path: /api/lhdg/v2/workpackage/project/findForPackage

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 否 项目名称

执行计划管理

执行计划管理-查询执行计划列表

基本信息

Path: /api/lhdg/v2/projectPlan/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 否 页数
pageSize 否 页大小
projectCode 否 项目编号
terminalParam 否 终端名称
brandStoreParam 否 品牌终端名称
province 否 省
city 否 市
area 否 区
status 否 计划状态
selectMonthStart 否 项目执行月份
selectMonthEnd 否 项目执行月份
positionCode 否 任务
positionName 否 任务名称
channelName 否 通路类别
operatorArea 否 经营者大区姓名
operatorPoint 否 经营者触点姓名
operatorGround 否 经营者场姓名
operatorCommunication 否 经营者沟通姓名
saleDelegate 否 品牌销售代表姓名
saleManager 否 品牌销售主管姓名
saleDirector 否 品牌销售经理姓名
bonusTemplateCode 否 激励方案
orgCode 否 组织code
planCode 否 项目计划编码

执行计划管理-查询项目编码名称下拉框

基本信息

Path: /api/lhdg/v2/projectPlan/project/findForDo

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 否 项目名称

费用管理

任务账单-任务账单列表

基本信息

Path: /api/lhdg/v2/taskbill/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 否 页数
pageSize 否 页大小
projectCodeOrName 否 项目名称/编号
positionCodeOrName 否 任务----岗位编号/名称
terminalCodeOrName 否 终端编码/名称
brandStoreCodeOrName 否 品牌终端编码/名称
pgCodeOrName 否 触点编码/名称
province 否 省
city 否 市
district 否 区
taskCode 否 任务模块编码
reportDateStart 否 计划执行日期-开始
reportDateEnd 否 计划执行日期-结束
reportTimeStart 否 提交时间-开始
reportTimeEnd 否 提交时间-结束
operatorGroundCodeOrName 否 经营者(场)姓名/编码
budgetType 否 预算类型
bookKeepTimeStart 否 记账时间-开始
bookKeepTimeEnd 否 记账时间-结束

经营助手

项目看板-月详情

基本信息

Path: /api/weekly/v2/taskBulletinBoard/terminalInfo

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 否 页数
pageSize 否 页大小
projectCode 否 项目编码
terminalTxt 否 终端名称/编码
terminaLabel 否 终端标签
province 否 省
city 否 市
district 否 区
salesStart 否 销量达成率区间起始
salesEnd 否 销量达成率区间结束
absoluteValueStart 否 绝对值区间起始
absoluteValueEnd 否 绝对值区间结束

项目看板-获取大项目下拉选

基本信息

Path: /api/weekly/v2/taskBulletinBoard/projectSetSelect

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
customer 是 所属客户

项目看板-获取大项目中子项目下拉选

基本信息

Path: /api/weekly/v2/taskBulletinBoard/projectSelect

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectSetCode 是 大项目编码

项目看板-获取客户下拉选

基本信息

Path: /api/weekly/v2/taskBulletinBoard/customerSelect

Method: GET

接口描述:

请求参数

激励模板

新建激励模板

基本信息

Path: /api/lhdg/v2/incentive/creat

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
mouldNamestring必须模板名称
mouldCodestring必须模板Code
incentiveTypestring必须激励设置
incentiveRulersobject []必须激励规则

item 类型: object

├─ ruleTypestring必须SKU或工作包
├─ ruleCodestring必须规则编码
├─ logicCodestring必须类型 金额/数量
├─ skuListstring []非必须单品列表

item 类型: string

├─ 非必须
├─ rulesobject []非必须提成阶梯

item 类型: object

├─ completeRatioSymbolstring非必须销量达成率符号
├─ completeRationumber非必须销量达成率
├─ completeCntSymbolstring非必须销量达成数量符号
├─ completeCntnumber非必须销量达成数量
├─ completeAmountSymbolstring非必须销量达成金额符号
├─ completeAmountnumber非必须销量达成金额
├─ unitPricenumber非必须提成单价
├─ commissionRationumber非必须提成比例
├─ cappedFeenumber非必须封顶费
├─ bonusAmountnumber非必须提成金额

返回数据

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

更新激励模版

基本信息

Path: /api/lhdg/v2/incentive/update

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
mouldNamestring必须模板名称
mouldCodestring必须模板Code
incentiveTypestring必须激励设置
incentiveRulersobject []必须激励规则

item 类型: object

├─ ruleTypestring必须SKU或工作包
├─ ruleCodestring必须规则编码
├─ logicCodestring必须类型 金额/数量
├─ skuListstring []非必须单品列表

item 类型: string

├─ 非必须
├─ rulesobject []非必须提成阶梯

item 类型: object

├─ completeRatioSymbolstring非必须销量达成率符号
├─ completeRationumber非必须销量达成率
├─ completeCntSymbolstring非必须销量达成数量符号
├─ completeCntnumber非必须销量达成数量
├─ completeAmountSymbolstring非必须销量达成金额符号
├─ completeAmountnumber非必须销量达成金额
├─ unitPricenumber非必须提成单价
├─ commissionRationumber非必须提成比例
├─ cappedFeenumber非必须封顶费
├─ bonusAmountnumber非必须提成金额

返回数据

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

查询激励模版详情

基本信息

Path: /api/lhdg/v2/incentive/findincentive

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
code 是 激励模板编码

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errCodestring非必须
errMessagestring非必须
dataobject非必须
├─ mouldNamestring必须模板名称
├─ mouldCodestring必须模板Code
├─ incentiveTypestring必须类型
├─ isUsedboolean必须是否被使用
├─ disabledboolean必须是否被禁用
├─ incentiveRulersobject []必须激励规则

item 类型: object

├─ ruleCodestring必须规则code
├─ ruleTypestring必须
├─ logicCodestring必须
├─ skuListobject []非必须已选择单品列表

item 类型: object

├─ codestring非必须单品编码
├─ barCodestring非必须单品条形码
├─ skuNamestring非必须单品名称
├─ statusstring非必须状态 0不可用 1可用
├─ rulesobject []非必须提成规则

item 类型: object

├─ ruleCodestring非必须规则code
├─ completeRatioSymbolstring非必须销量达成率符号
├─ completeRationumber非必须销量达成率
├─ completeCntSymbolstring非必须销量达成数量符号
├─ completeCntinteger非必须销量达成数量
├─ completeAmountSymbolstring非必须销量达成金额符号
├─ completeAmountnumber非必须销量达成金额
├─ unitPricenumber非必须提成单价
├─ commissionRationumber非必须提成比例
├─ seqinteger非必须排列序号
├─ cappedFeenumber非必须封顶费
├─ bonusAmountnumber非必须提成金额
├─ commissionIndexUnitstring非必须
├─ commissionIndexUnitCodestring非必须
├─ unitIndexUnitstring非必须
├─ unitIndexUnitCodestring非必须
├─ amountIndexUnitstring非必须
├─ amountIndexUnitCodestring非必须

销量管理

POS销量管理-项目名称编码下拉框

基本信息

Path: /api/lhdg/v2/salesVolume/project/find

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 是 项目名称或编码

销量管理列表

基本信息

Path: /api/lhdg/v2/salesVolume/list

Method: GET

接口描述:

作用:销量上报列表查询。开发环境:灵活导购后台。权限:超级管理员/项目创建人。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
X-Request-Id 12345678 是
X-Request-Sky-Serve f1kin>10.244.4.80 是
X-Request-Sky-Sessionid S3.Trc08jLBfuTgsZT8XnNtJMvBT_uMBJeu4450Ru5CRMbUZoVP7tf9YwMyUlCYpP_1dT46b1Bxtc3 是
X-Request-Sky-Authorize eyJqdGkiOiJUcmMwOGpMQmZ1VGdzWlQ4WG5OdEpNdkJUIiwiYXVkIjoiMWRUNDZiMUJ4dGMzIiwiZXhwIjoxNjQ0NDY2MDk5LCJpYXQiOjE2NDQ0NTg4OTksImlzcyI6InNzby5kZXYuazhzLmxvY2FsIiwibmJmIjoxNjQ0NDU4ODk5LCJzdWIiOiJ1TUJKZXU0NDUwUnU1Q1JNYlVab1ZQN3RmOVl3TXlVbENZcFAiLCJuYW0iOiLljaLlubMiLCJpZHMiOiI1MU40TkpkS0h0S0wySUNsIiwiaWQyIjpbNTQsMTMsMiwxOSw5NywwLDAsNDVdLCJ1Y28iOiJ1QzdPV2tHQjJ2SFpKbzlIRG1IV2doNXI2QzJGT2JDRCIsInVuYSI6IuWNouW5syIsInRrZCI6IjAiLCJ0Y28iOiJ0QzM5SGg0OUYwTU8zQ3cyblNGdXBTSE8iLCJ0bmEiOiJ0ZW5hbnRUZXN0IiwidHVjIjoidVQzOUhqRzZJQ1JyVG80VXp4RXdJM0VVSFJ0eGZWMmsiLCJ0Y2MiOiJ1VDM5SGpHNklDUnJUbzRVenhFd0kzRVVIUnR4ZlYyayIsInR1biI6IuWNouW5syIsImFwcCI6IjEwMDAwMDEiLCJhcG4iOiLnu4/okKXogIXkuK3lj7AiLCJ0cGciOiJvd25lciIsInR1cCI6IjE4NDgyMTkyMTI0Iiwibm5tIjoiMTg0ODIxOTIxMjQiLCJmbHciOiJmT2NBTmtoMEhuTDlOR0loczR2ZjJ6RDJ2V0MxdmtZWmt0UWdZdG42ZTJnVEpMVHYiLCJha2QiOiIzIiwibm9uY2UiOiJCcTNKcVc4QjMweDFHakFSIn0= 是
X-Request-Sky-Signature b2mbWMCFpTx1PcI4vdu6eb20zZxtzBSG01yY4xrX1Ae6jbokPeBpErMKNcPzDZqk_KaSQx8fMSwj1vTj_rObsg== 是

Query

参数名称 是否必须 示例 备注
pageNumber 是 当前页
pageSize 是 每页显示条数
projectCode 否 项目编码
projectName 否 项目名称
terminalName 否 终端名称
uploadFrequency 否 销量上传频率
bonusTemplateCode 否 激励模板编码
bonusTemplateName 否 激励模板名称
status 否 状态
planCode 否 终端计划编码
brandStoreCode 否 品牌终端编码
brandStoreName 否 品牌终端名称
terminalCode 否 门店编码
weekNo 否 周
provinceAndCity 否 省市区
incentiveType 否 激励模板类型(任务包/sku/混合)
positionCode 否 岗位编码
minReachRate 否 达成率最小值
maxReachRate 否 达成率最大值

返回数据

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

mock: 2

dataobject []必须

item 类型: object

├─ bonusTemplateCodestring必须激励模板编码

mock: T0004

├─ projectCodestring必须项目编码

mock: AAAABGX1231

├─ projectNamestring必须项目名字

mock: AAAABGX1231

├─ createDaystring必须立项日期

mock: 2021-12-31

├─ startDatestring必须开始日期

mock: 2022-01-03

├─ endDatestring必须结束日期

mock: 2022-01-30

├─ endUploadDatestring必须截止上传日期

mock: 2022-03-31

├─ uploadFrequencystring必须上传频率

mock: MONTH

├─ statusstring必须状态

mock: UPLOADING

├─ reportRatestring必须上报率

mock: 50

├─ updaterstring必须更新人

mock: 215736

├─ updateTimestring必须最后更新时间

mock: 2022-01-03 00:00:02

销量管理导入模板

基本信息

Path: /salesVolume/exportTemplate

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 saleZGX0817 项目编码
uploadFrequency 是 WEEK 上传频率

返回数据

名称类型是否必须默认值备注其他信息
errCodestring非必须错误编码
errMessagestring非必须错误信息
datastring非必须销量上报导入模板的下载地址

mock: https://fmes.oss-cn-shanghai.aliyuncs.com/lhdg-test/19033/销量管理导入周模板1644475530564.xlsx?Expires=1644478531&OSSAccessKeyId=LTAI4GH389TyyoCe1VXKeAEB&Signature=LizZKhCYG5HGVfotk+iUyCz5w2s=

successboolean非必须成功标识

销量管理上传

基本信息

Path: /salesVolume/import

Method: POST

接口描述:

请求参数

Headers

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

Body

参数名称 参数类型 是否必须 示例 备注
file file 是 销量上报的excel文件

返回数据

名称类型是否必须默认值备注其他信息
errCodenull非必须错误编码
errMessagenull非必须错误信息
dataobject非必须数据
├─ addNumnull非必须添加成功的条数
├─ allNumnull非必须导入总记录条数
├─ failNumnull非必须添加失败的条数
├─ absoluteUrlnull非必须
├─ isSuccessnull非必须是否成功
├─ errTypestring非必须
successboolean非必须成功标识

销量管理导出

基本信息

Path: /salesVolume/export

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 saleZGX0817 项目编码
uploadFrequency 是 WEEK 上传频率

返回数据

名称类型是否必须默认值备注其他信息
errCodestring非必须错误编码
errMessagestring非必须错误信息
datastring非必须销量上报导出地址

mock: "https://fmes.oss-cn-shanghai.aliyuncs.com/lhdg-test/19033/销量管理导出周1644476265405.xlsx?Expires=1644479265&OSSAccessKeyId=LTAI4GH389TyyoCe1VXKeAEB&Signature=V536vmru+qFCF1h8a4Ial0ScJaM=

successboolean非必须成功标识

详情页——获取销量上报项目信息

基本信息

Path: /salesVolume/getProjectInfo

Method: GET

接口描述:

获取销量上报项目信息

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 "WWWWWGX0406" 项目编码

返回数据

名称类型是否必须默认值备注其他信息
bonusTemplateCodestring非必须激励模板编码
projectCodestring非必须项目编码
projectNamestring非必须项目名称
createDaystring非必须立项日期
startDatestring非必须开始日期
endDatestring非必须结束日期
endUploadDatestring非必须截至上传日期
uploadFrequencystring非必须上传频率
statusstring非必须状态
reportRatenumber非必须上报率
updaterstring非必须更新人
updateTimestring非必须更新时间

详情页 —— 获取项目的激励模板

基本信息

Path: /salesVolume/getProjectBonusTemplate

Method: POST

接口描述:

销量上报详情页获取项目的激励模板

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
projectCode text 是 项目编码 项目编码
projectName text 否 项目名称 项目名称
terminalName text 否 终端名称 终端名称
uploadFrequency text 是 销量上传频率 销量上传频率
bonusTemplateCode text 否 激励模板编码 激励模板类型(任务包/sku/混合)
bonusTemplateName text 否 激励模板名称 岗位编码
status text 否 状态 达成率最小值
planCode text 否 终端计划编码 达成率最大值
brandStoreCode text 否 品牌终端编码 品牌终端编码
brandStoreName text 否 品牌终端名称 品牌终端名称
terminalCode text 否 门店编码 门店编码
weekNo text 否 周 周
incentiveType text 否 激励模板类型(任务包/sku/混合) 激励模板类型(任务包/sku/混合)
positionCode text 否 岗位编码 岗位编码
minReachRate text 否 达成率最小值 达成率最小值
maxReachRate text 否 达成率最大值 达成率最大值
provinceAndCity text 否 省市区 省市区

返回数据

名称类型是否必须默认值备注其他信息
templateCodestring必须激励模板编码

mock: T0004

templateNamestring必须激励模板名字

mock: T0004

incentiveTypestring必须激励模板类型

mock: ONLY_SKU

valuestring必须值

mock: 组合(任务包 + SKU)

详情页——顶部的统计和每周的统计

基本信息

Path: /salesVolume/statistics

Method: POST

接口描述:

详情页——顶部的统计和每周的统计

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
projectCode text 是 项目编码 项目编码
weekNo text 是 周 周
incentiveType text 是 激励模板类型(任务包/sku/混合) 激励模板类型(任务包/sku/混合)
uploadFrequency text 是 销量上传频率 销量上传频率
bonusTemplateCode text 是 激励模板编码 激励模板编码
projectName text 否 项目名称 项目名称
terminalName text 否 终端名称 终端名称
bonusTemplateName text 否 激励模板名称 激励模板名称
status text 否 状态 状态
planCode text 否 终端计划编码 终端计划编码
brandStoreCode text 否 品牌终端编码 品牌终端编码
brandStoreName text 否 品牌终端名称 品牌终端名称
terminalCode text 否 门店编码 门店编码
positionCode text 否 岗位编码 岗位编码
minReachRate text 否 达成率最小值 达成率最小值
maxReachRate text 否 达成率最大值 达成率最大值
provinceAndCity text 否 省市区 省市区

返回数据

名称类型是否必须默认值备注其他信息
salesAchievedstring非必须任务包销量达成
reachRatestring非必须任务包达成率
reportRatestring非必须上报率
incentiveCOobject非必须激励规则
├─ mouldNamestring非必须模板名称
├─ mouldCodestring非必须模板编码
├─ incentiveTypestring非必须类型
├─ isUsedstring非必须是否被使用
├─ disabledstring非必须使用情况
├─ incentiveRulersobject非必须激励规则
├─ ruleCodestring非必须规则code
├─ ruleTypestring非必须规则类型
├─ logicCodestring非必须登陆人code
├─ skuListobject非必须sku列表
├─ codestring非必须sku编码
├─ barCodestring非必须
├─ skuNamestring非必须sku名称
incentiveTypestring非必须计量维度
reportingNumnumber非必须已上报终端数量
reportingTotalnumber非必须月上报终端总数
packageUnitstring非必须任务包的计量单位
weekInformationobject非必须周销量信息
├─ weeknumber非必须
├─ startTimestring非必须考勤所在周的开始时间
├─ endTimestring非必须考勤所在周的结束时间
├─ reportRatestring非必须上报率
├─ reportingNumnumber非必须已上报终端数量
├─ reportingTotalnumber非必须周或月上报终端总数
├─ salesAchievedstring非必须累计销量达成
├─ reachRatestring非必须达成率

详情页——销量管理分页列表

基本信息

Path: /salesVolume/details

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
uploadFrequency 是 销量上传频率 销量上传频率
weekNo 是 周 周
projectCode 否 项目编码 项目编码
projectName 否 项目名称 项目名称
terminalName 否 终端名称 终端名称
bonusTemplateCode 否 激励模板编码 激励模板编码
bonusTemplateName 否 激励模板名称 激励模板名称
status 否 状态 状态
planCode 否 终端计划编码 终端计划编码
brandStoreCode 否 品牌终端编码 品牌终端编码
brandStoreName 否 品牌终端名称 品牌终端名称
terminalCode 否 门店编码 门店编码
incentiveType 否 激励模板类型(任务包/sku/混合) 激励模板类型(任务包/sku/混合)
positionCode 否 岗位编码 岗位编码
minReachRate 否 达成率最小值 达成率最小值
maxReachRate 否 达成率最大值 达成率最大值
provinceAndCity 否 省市区 省市区

返回数据

名称类型是否必须默认值备注其他信息
totalnumber非必须总条数
dataobject []非必须数据

item 类型: object

├─ positionNamestring非必须岗位
├─ terminalNamenull非必须终端名称
├─ provincenull非必须省
├─ citynull非必须市
├─ districtnull非必须区
├─ brandStoreNamestring非必须品牌终端名称
├─ terminalCodestring非必须终端编码
├─ uploadTimestring非必须上传时间
├─ brandStoreCodestring非必须品牌终端编码
columnsobject []非必须动态列

item 类型: object

├─ titlestring必须动态列名称
├─ dataIndexstring必须动态列名称

任务执行报表

任务执行excel导出

基本信息

Path: /taskExecution/getExecutionReportExcel

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
reviewer 是 任务执行日期开始
auditTime 是 任务执行日期结束
currentPage 是 当前页
pageNum 是 每页显示的条数
projectStr 否 项目编码
province 否 省
city 否 市
district 否 区
terminalCode 否 终端编码
executionCompletionStatus 否 任务执行完成状态
qualified 否 任务是否合格
operatorCode 否 经营者编码
contactCode 否 触点编码

返回数据

名称类型是否必须默认值备注其他信息
errCodestring非必须错误标识
errMessagestring非必须错误信息
datastring非必须执行报表返回路径
successboolean非必须成功标识

任务执行列表

基本信息

Path: /taskExecution/getExecutionReport

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
reviewer 是 任务执行日期开始 任务执行日期开始
auditTime 是 任务执行日期结束 任务执行日期结束
currentPage 是 当前页 当前页
pageNum 是 每页显示的条数 每页显示的条数
projectStr 否 项目编码 项目编码
province 否 省 省
city 否 市 市
district 否 区 区
terminalCode 否 终端编码 终端编码
executionCompletionStatus 否 任务执行完成状态 任务执行完成状态
qualified 否 任务是否合格 任务是否合格
operatorCode 否 经营者编码 经营者编码
contactCode 否 触点编码 触点编码

返回数据

名称类型是否必须默认值备注其他信息
totalnumber必须总条数
dataobject []必须

item 类型: object

├─ prjCodestring必须项目编码
├─ prjNamestring必须项目名称
├─ c2string必须任务名称
├─ c3string必须任务编码
├─ channelProvinceAdNamestring必须省
├─ channelCityAdNamestring必须市
├─ channelAdNamestring必须区
├─ channelCodestring必须终端编码
├─ channelNamestring必须终端名称
├─ custChannelCodestring必须品牌终端编码
├─ custChannelNamestring必须品牌终端名称
├─ execute_cntstring必须计划执行天数
├─ swNamestring必须计划执行时段
├─ scheduleNumstring必须任务序号【卖进id】
├─ citySupervisorCodestring必须经营者编码
├─ citySupervisorNamestring必须经营者名称
├─ salesNamestring必须触点名称
├─ salesEmpPkstring必须触点编码
├─ scScheduleDatestring必须任务执行日期
├─ weekIndexstring必须考勤周次
├─ scheduleTimeQtmstring必须可执行时间
├─ attStartTimestring必须任务执行开始时间
├─ attEndTimestring必须任务执行结束时间
├─ isAttStartstring必须是否开始任务执行
├─ isAttStartExcpstring必须开始任务执行定位是否正常(误差值≤800米)
├─ attDistanceInstring必须开始任务执行定位误差(米)
├─ isAttEndstring必须是否结束任务执行
├─ isAttEndExcpstring必须结束任务执行定位是否正常(误差值≤800米)
├─ attDistanceOutstring必须结束任务执行定位误差(米)
├─ isAttTwicestring必须任务开始\结束是否完整执行
├─ isAttTwiceStdstring必须任务执行是否合格
├─ scheduletypestring必须执行完成状态

项目执行配置

考题配置——新建和更新考题配置

基本信息

Path: /projectExecution/questionConfig/createrQuestionConfig

Method: POST

接口描述:

项目执行配置中,保存触点任务配置到epda系统的数据库。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
questionConfigCode 是 考题编码
c1 是 项目编码
c2 是 项目名称
maxAnswersNum 是 最大答题数
randomQuestionsNum 是 随机考题数
randomKeyQuestions 是 随机重点题
versionNum 是 版本号
questionList 是 关联考题表
questionCode 是 考题编码
c1 是 项目编码
c2 是 项目名称
title 是 标题
optionOne 是 选项一
optionTwo 是 选项二
optionThree 是 选项三
optionFour 是 选项四
optionFive 是 选项五
rightKey 是 正确答案
topicSetting 是 题目设置【开启,禁用】
questionType 是 题型设置【单选,多选】
topicLevel 是 题目级别【普通,重点】

Body

参数名称 参数类型 是否必须 示例 备注
questionConfigCode text 是 考题编码
c1 text 是 项目编码
c2 text 是 项目名称
maxAnswersNum text 是 最大答题数
randomQuestionsNum text 是 随机考题数
randomKeyQuestions text 是 随机重点题
versionNum text 是 版本号
questionList text 是 关联考题表
questionCode text 是 考题编码
c1 text 是 项目编码
c2 text 是 项目名称
title text 是 标题
optionOne text 是 选项一
optionTwo text 是 选项二
optionThree text 是 选项三
optionFour text 是 选项四
optionFive text 是 选项五
rightKey text 是 正确答案
topicSetting text 是 题目设置
questionType text 是 题型设置
topicLevel text 是 题目级别

返回数据

名称类型是否必须默认值备注其他信息
errCodenull非必须错误标识
errMessagenull非必须错误信息
successboolean非必须成功标识

考题配置——查询考题配置

基本信息

Path: /projectExecution/questionConfig/selectQuestionConfigList

Method: GET

接口描述:

项目执行配置中,考题配置页面查询考题配置。

请求参数

Query

参数名称 是否必须 示例 备注
c1 是 项目编码
questionConfigCode 否 考题配置编码
c2 否 项目名称

返回数据

名称类型是否必须默认值备注其他信息
errCodenull非必须错误标识
errMessagenull非必须错误信息
totalnumber非必须总条数
dataobject []非必须返回数据

item 类型: object

├─ questionConfigCodestring必须考题编码
├─ c1string必须项目编码
├─ c2string必须项目名称
├─ maxAnswersNumnumber必须最大答题数
├─ randomQuestionsNumnumber必须随机考题数
├─ randomKeyQuestionsnumber必须随机重点题
├─ versionnumber必须版本号
├─ questionListobject []必须考题列表

item 类型: object

├─ questionCodestring必须考题编码
├─ c1string必须项目编码
├─ c2string必须项目名称
├─ titlestring必须标题
├─ optionOnestring必须选项一
├─ optionTwostring必须选项二
├─ optionThreestring必须选项三
├─ optionFourstring,null必须选项四
├─ optionFivenull必须选项五
├─ rightKeystring必须正确答案
├─ topicSettingstring必须题目设置
├─ questionTypestring必须题型设置
├─ topicLevelstring必须题目级别
├─ optionMaxstring必须考题选项总数
successboolean非必须成功标识

考题配置——考题导入模板

基本信息

Path: /projectExecution/questionConfig/questionTemplate

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
errCodenull非必须错误标识
errMessagenull非必须错误信息
datastring非必须返回的考题模板下载地址

mock: https://fmes.oss-cn-shanghai.aliyuncs.com/lhdg-test/19034/考题导入模板1644550200141.xlsx?Expires=1644553200&OSSAccessKeyId=LTAI4GH389TyyoCe1VXKeAEB&Signature=fF/e1XigAxGAclp0l9RgK7y9Ars=

successboolean非必须成功标识

考题配置——考题配置导出

基本信息

Path: /projectExecution/questionConfig/questionConfigDownLoadTemplate

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
c1 text 是 项目编码
c2 text 否 项目名称
questionConfigCode text 否 考题配置编码

返回数据

名称类型是否必须默认值备注其他信息
errCodenull非必须错误标识
datastring非必须考题导出的下载路径
successboolean非必须成功标识

触点任务配置——保存任务库编码

基本信息

Path: /projectTaskStep/saveProjectTaskStep

Method: POST

接口描述:

执行项目配置中的触点任务配置,用于将项目维度的任务库编码保存到数据库。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
projectCode text 是 项目编码
projectName text 否 项目名称
libCode text 是 任务库编码

返回数据

名称类型是否必须默认值备注其他信息
errCodestring非必须错误标识
errMessagestring非必须错误信息
datanull非必须返回数据
successboolean非必须成功标识

触点任务配置——查询任务库编码

基本信息

Path: /projectTaskStep/findProjectTaskInfo

Method: GET

接口描述:

项目执行配置中,触点任务配置根据项目编码查询任务库编码。

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 项目编码
projectName 否 项目名称

返回数据

名称类型是否必须默认值备注其他信息
projectCodestring必须项目编码
projectNamestring必须项目名称
libCodestring必须任务库编码

触点任务配置——校验项目是否结束

基本信息

Path: /projectTaskStep/checkProject

Method: GET

接口描述:

项目执行配置中的触点任务配置,保存任务库编码时判断项目是否已经结束,如果项目已结束,则不可进行修改。如果项目未结束,则可以进行修改。

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 项目编码

返回数据

名称类型是否必须默认值备注其他信息
datastring非必须如果为false,项目未结束。如果为true,项目已结束。

mock: false

errCodestring非必须错误标识
errMessagestring非必须错误信息
successstring非必须成功标识

项目执行配置-查询项目执行列表

基本信息

Path: /api/lhdg/v2/projectExecution/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 是 页数
pageSize 是 页大小
project 是 项目名称
projectCode 是 项目编码
creatorParam 是 项目创建人姓名
status 是 项目状态
projectCategory 是 项目类型

项目执行配置-项目名称编码下拉框

基本信息

Path: /api/lhdg/v2/projectExecution/findForDo

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 否 项目名称

项目管理

终端计划-查询计划列表

基本信息

Path: /api/lhdg/v2/terminalPlan/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 否 页数
pageSize 否 页大小
projectCode 否 项目编码
terminalParam 否 系统终端名称/编码
brandStoreParam 否 品牌门店名称/编码
selectMonthStart 否 项目执行月份 开始月份
selectMonthEnd 否 项目执行月份 结束月份
provinceName 否 省
cityName 否 市
regionName 否 区
channelName 否 通路类别
saleDelegate 否 品牌销售代表姓名
saleDirector 否 品牌销售经理姓名
saleManager 否 品牌销售主管姓名
status 否 状态
position 否 任务
bonusTemplateCode 否 激励方案查询
planCode 否 计划编码

终端计划-项目名称编码下拉列表

基本信息

Path: /api/lhdg/v2/terminalPlan/project/find

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 否 项目编码或名称

项目列表-查询项目列表

基本信息

Path: /api/lhdg/v2/project/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 否 页数
pageSize 否 每页大小
project 否 项目名称
projectCode 否 项目编码
creatorParam 否 项目创建人姓名
status 否 项目状态
projectCategory 否 项目类型

项目列表-项目名称编码下拉列表

基本信息

Path: /api/lhdg/v2/project/find

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 否 模糊查询参数,可输入项目名或项目编码

项目详情-修改项目是否需要开启填写通过原因及是否必填标记

基本信息

Path: /project/updatePassReasonFlg

Method: POST

接口描述:

请求参数

Headers

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

Query

参数名称 是否必须 示例 备注
projectCode 是 WZAAAGX202203021 项目名称
flg 是 false false:开启; true:关闭

Body

{
    /**
     * 项目编码
     */
    "projectCode" : "xxxx",
    /**
     * 审核通过原因是否需要开启标记(true开启,false关闭)
     */
    "passReasonFlg" : false,
    /**
     * 审核通过原因是否必填标记(true必填,false非必填)
     */
    "passRequiredFlg" :false,
    /**
     * 审核驳回原因是否需要开启标记(true开启,false关闭)
     */
    "rejectReasonFlg" : true,
    /**
     * 审核驳回原因是否必填标记(true必填,false非必填)
     */
    "rejectRequiredFlg" :true
}

返回数据

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

项目详情-更新项目品牌配置

基本信息

Path: /project/updateBrands

Method: POST

接口描述:

请求参数

Headers

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

Body

[
   {
      "positionCode": "POSFCPB2DG4K43",
      "subBrand": "BRD0000000128"
   }
]

返回数据

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

项目详情-基础信息-选择项目所属组下拉框列表

基本信息

Path: /lgselect/project/findAuthGroup

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
structureName 否 架构名称

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "extValues": {},
         "name": "执行test001",
         "code": "STXDXVX6JV6S"
      }
   ],
   "success": true
}

项目详情-基础信息-查询客户项目下拉列表

基本信息

Path: /lgselect/project/findProjectForCreate

Method: GET

接口描述:

请求参数

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "value": "CUSFMESTEST002",
         "label": "FMES测试李",
         "children": [
            {
               "value": "PJS5RLF3FFMES2",
               "label": "FMES测试2.0项目李"
            }
         ]
      },
      {
         "value": "CUSFMESTEST001",
         "label": "FMES测试",
         "children": [
            {
               "value": "PJS5RLF3FFMES021",
               "label": "FMES测试2.0项目021"
            },
            {
               "value": "PJS5RLF3FFMES022",
               "label": "FMES测试2.0项目022"
            },
            {
               "value": "PJS5RLF3FFMES023",
               "label": "FMES测试2.0项目023"
            },
            {
               "value": "PJS5RLF3FFMES024",
               "label": "FMES测试2.0项目024"
            },
            {
               "value": "PJS5RLF3FFMES025",
               "label": "FMES测试2.0项目025"
            },
            {
               "value": "PJS5RLF3FFMES026",
               "label": "FMES测试2.0项目026"
            },
            {
               "value": "PJS5RLF3FFMES027",
               "label": "FMES测试2.0项目027"
            },
            {
               "value": "PJS5RLF3FFMES028",
               "label": "FMES测试2.0项目028"
            },
            {
               "value": "PJS5RLF3FFMES029",
               "label": "FMES测试2.0项目029"
            },
            {
               "value": "PJS5RLF3FFMES030",
               "label": "FMES测试2.0项目030"
            }
         ]
      }
   ],
   "success": true
}

项目详情-基础信息-查询项目信息

基本信息

Path: /project/findProject/{code}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
code TESTXGX045 项目编码

返回数据

{
   "errCode": null,
   "errMessage": null,
   "data": {
      "id": 100247,
      "projectName": "TESTXGX045",
      "projectCode": "TESTXGX045",
      "budgetCode": null,
      "startDate": "2022-02-25",
      "endDate": "2022-03-31",
      "category": "LHDG",
      "uploadFrequency": "MONTH",
      "memo": null,
      "structureCode": null,
      "projectDataList": [
         {
            "fileName": "终端计划导入模板.xlsx",
            "fileUrl": "project/19048/终端计划导入模板.xlsx",
            "absoluteFileUrl": "https://fmes.oss-cn-shanghai.aliyuncs.com/lhdg-test/project/19048/终端计划导入模板.xlsx?Expires=1646208787&OSSAccessKeyId=LTAI4GH389TyyoCe1VXKeAEB&Signature=cBEii+37qb4nnqGUfqKUYnValfQ="
         }
      ],
      "version": 1,
      "continueConfigCO": {
         "lastProjectCode": null,
         "lastProjectName": null,
         "positionContinue": false,
         "brandContinue": false,
         "recruitmentContinue": false,
         "terminalPlanContinue": false,
         "businessDirectorContinue": false,
         "dataContinue": false,
         "projectPlanContinue": false
      },
      "projectMonth": "2022-03",
      "projectSetCode": "PJS5RLF3FFMES023",
      "customerCode": null
   },
   "success": true
}

项目详情-基础信息-查询项目步骤

基本信息

Path: /project/page/{code}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
code TESTXGX045 项目编码

返回数据

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

项目详情-基础信息-延续项目下拉列表查询

基本信息

Path: /lgselect/project/find

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 否 项目编码

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 20,
   "data": [
      {
         "extValues": {},
         "name": "TESTXGX046",
         "code": "TESTXGX046"
      },
      {
         "extValues": {},
         "name": "TESTXGX045",
         "code": "TESTXGX045"
      },
      {
         "extValues": {},
         "name": "TESTXGX044",
         "code": "TESTXGX044"
      },
      {
         "extValues": {},
         "name": "TESTXGX043",
         "code": "TESTXGX043"
      },
      {
         "extValues": {},
         "name": "TESTXGX042",
         "code": "TESTXGX042"
      },
      {
         "extValues": {},
         "name": "TESTXGX041",
         "code": "TESTXGX041"
      },
      {
         "extValues": {},
         "name": "TESTXGX039",
         "code": "TESTXGX039"
      },
      {
         "extValues": {},
         "name": "TESTXGX040",
         "code": "TESTXGX040"
      },
      {
         "extValues": {},
         "name": "TESTXGX038",
         "code": "TESTXGX038"
      },
      {
         "extValues": {},
         "name": "TESTXGX037",
         "code": "TESTXGX037"
      },
      {
         "extValues": {},
         "name": "工作表测试",
         "code": "TESTXGX035"
      },
      {
         "extValues": {},
         "name": "测试更新计划总销量目标",
         "code": "TESTXGX034"
      },
      {
         "extValues": {},
         "name": "项目创建排序测试",
         "code": "TESTXGX033"
      },
      {
         "extValues": {},
         "name": "项目计划测试销量",
         "code": "TESTXGX032"
      },
      {
         "extValues": {},
         "name": "测试项目1",
         "code": "TESTXGX031"
      },
      {
         "extValues": {},
         "name": "测试流程",
         "code": "TESTXGX030"
      },
      {
         "extValues": {},
         "name": "终端南侧",
         "code": "TESTXGX029"
      },
      {
         "extValues": {},
         "name": "Y22测试1月?",
         "code": "Y22TEST1M"
      },
      {
         "extValues": {},
         "name": "TESTXGX027",
         "code": "TESTXGX027"
      },
      {
         "extValues": {},
         "name": "TESTXGX025",
         "code": "TESTXGX025"
      }
   ],
   "success": true
}

项目详情-基础信息-项目类型下拉列表查询

基本信息

Path: /master/mastervalues/{masterCode}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
masterCode PROJECT_CATEGORY

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "code": "LHDG",
         "value": "灵活导购"
      }
   ],
   "success": true
}

项目详情-任务配置-岗位配置查询

基本信息

Path: /project/findPosition/{code}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
code TESTXGX045 项目编码

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "positionCode": "POS7Q2MCM2RTVY",
         "positionName": "岗位一",
         "lastPositionCode": null
      }
   ],
   "success": true
}

项目详情-品牌配置-查询品牌树

基本信息

Path: /lgselect/brand/find

Method: GET

接口描述:

请求参数

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "brandCode": "brandCode001",
         "brandName": "brandName001",
         "brandParCode": null,
         "deep": "1",
         "children": [
            {
               "brandCode": "brandCode002",
               "brandName": "brandName002",
               "brandParCode": "brandCode001",
               "deep": "2",
               "children": null
            },
            {
               "brandCode": "brandCode003",
               "brandName": "brandName003",
               "brandParCode": "brandCode001",
               "deep": "2",
               "children": null
            },
            {
               "brandCode": "brandCode004",
               "brandName": "brandName004",
               "brandParCode": "brandCode001",
               "deep": "2",
               "children": null
            }
         ]
      },
      {
         "brandCode": "brandCode001",
         "brandName": "brandName001",
         "brandParCode": null,
         "deep": "1",
         "children": null
      }
   ],
   "success": true
}

项目详情-品牌配置-查询项目的品牌配置

基本信息

Path: /project/findPositionBrands/{code}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
code 项目编码

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "positionCode": "POSF4J3X5J5Y43",
         "positionName": "王卓触点测试任务3",
         "projectBrands": [
            {
               "brands": [
                  "brandCode001",
                  "brandCode002",
                  "brandCode003"
               ]
            },
            {
               "brands": [
                  "brandCode001",
                  "brandCode002",
                  "brandCode003"
               ]
            }
         ]
      },
      {
         "positionCode": "POSF4GC37DE843",
         "positionName": "王卓触点测试任务4",
         "projectBrands": [
            {
               "brands": [
                  "brandCode001",
                  "brandCode002",
                  "brandCode003"
               ]
            }
         ]
      }
   ],
   "success": true
}

项目详情-任务说明配置-招聘查询

基本信息

Path: /project/findRecruitment/{code}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
code TESTXGX046 项目编码

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "projectCode": "TESTXGX046",
         "projectName": "TESTXGX046",
         "positionCode": "POSF77GMUY5S3",
         "positionName": "岗位1",
         "recruitExplain": null,
         "salary": null,
         "welfare": null,
         "require": null,
         "standardCOs": [],
         "brandOuts": [],
         "ruleMap": {}
      },
      {
         "projectCode": "TESTXGX046",
         "projectName": "TESTXGX046",
         "positionCode": "POSF77A3453MS3",
         "positionName": "岗位2",
         "recruitExplain": null,
         "salary": null,
         "welfare": null,
         "require": null,
         "standardCOs": [],
         "brandOuts": [],
         "ruleMap": {}
      },
      {
         "projectCode": "TESTXGX046",
         "projectName": "TESTXGX046",
         "positionCode": "POSF7P3XXCYXS3",
         "positionName": "岗位三",
         "recruitExplain": null,
         "salary": null,
         "welfare": null,
         "require": null,
         "standardCOs": [],
         "brandOuts": [],
         "ruleMap": {}
      }
   ],
   "success": true
}

项目详情-任务说明配置-添加行业品类列表

基本信息

Path: /master/masterIndustry

Method: GET

接口描述:

请求参数

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 0,
   "data": [
      {
         "industryCode": "IND0000000001",
         "industryName": "水乳饮料"
      },
      {
         "industryCode": "IND0000000002",
         "industryName": "医疗保健"
      },
      {
         "industryCode": "IND0000000003",
         "industryName": "休闲食品"
      },
      {
         "industryCode": "IND0000000004",
         "industryName": "中外名酒"
      },
      {
         "industryCode": "IND0000000005",
         "industryName": "母婴玩具"
      },
      {
         "industryCode": "IND0000000006",
         "industryName": "日化美妆"
      },
      {
         "industryCode": "IND0000000007",
         "industryName": "粮油副食"
      },
      {
         "industryCode": "IND0000000008",
         "industryName": "电子商务"
      },
      {
         "industryCode": "IND0000000009",
         "industryName": "办公文具"
      }
   ],
   "success": true
}

项目详情-任务说明配置-查询招聘标签

基本信息

Path: /project/recruitLabel

Method: GET

接口描述:

请求参数

返回数据

{
   "recruitExplains": [
      {
         "labelId": 1,
         "labelCode": "EXP001",
         "labelName": "促销"
      },
      {
         "labelId": 2,
         "labelCode": "EXP002",
         "labelName": "理货"
      },
      {
         "labelId": 3,
         "labelCode": "EXP003",
         "labelName": "试吃"
      }
   ],
   "salarys": [
      {
         "labelId": 4,
         "labelCode": "SAL001",
         "labelName": "day150"
      },
      {
         "labelId": 5,
         "labelCode": "SAL002",
         "labelName": "day200"
      },
      {
         "labelId": 6,
         "labelCode": "SAL002",
         "labelName": "day250"
      },
      {
         "labelId": 7,
         "labelCode": "SAL002",
         "labelName": "day300"
      }
   ],
   "welfares": [
      {
         "labelId": 8,
         "labelCode": "W00001",
         "labelName": "996福报"
      }
   ],
   "requires": [
      {
         "labelId": 9,
         "labelCode": "R00001",
         "labelName": "90岁"
      },
      {
         "labelId": 10,
         "labelCode": "R00002",
         "labelName": "女"
      }
   ]
}

终端计划-新建计划选择SKU弹窗列表

基本信息

Path: /basicdata/findAgencySKUs

Method: GET

接口描述:

请求参数

返回数据

{
   "errCode": null,
   "errMessage": null,
   "total": 100,
   "data": [
      {
         "barCode": "5555",
         "skuCode": "STS000FTQYEW3KXLL",
         "skuName": "洗手液2",
         "brandCode": "singleproductXPCGELPSLL2K",
         "brandName": "A2/12/3",
         "categoryCode": "categoryFTNQYC4KYLL",
         "categoryName": "未分类"
      },
      {
         "barCode": "123",
         "skuCode": "STS000F57VP4GBDLL",
         "skuName": "12",
         "brandCode": "singleproductXT5AK38BS2K",
         "brandName": "apple",
         "categoryCode": "category3JX36M8Q2YK",
         "categoryName": "未分类"
      },
      {
         "barCode": "2114151",
         "skuCode": "STS00079MD8CHRWF5",
         "skuName": "喜之郎333",
         "brandCode": "singleproduct3YU9M2ZW3SN",
         "brandName": "喜之郎",
         "categoryCode": "category3Q5FLQB7HM",
         "categoryName": "未分类"
      },
      {
         "barCode": "2114153211",
         "skuCode": "STS0007DX7NHF64F5",
         "skuName": "喜之郎331",
         "brandCode": "singleproduct3YU9M2ZW3SN",
         "brandName": "喜之郎",
         "categoryCode": "category3Q5FLQB7HM",
         "categoryName": "未分类"
      },
      {
         "barCode": "21141153211",
         "skuCode": "STS0007DC3KCC7QF5",
         "skuName": "喜之郎321",
         "brandCode": "singleproduct3YU9M2ZW3SN",
         "brandName": "喜之郎",
         "categoryCode": "category3Q5FLQB7HM",
         "categoryName": "未分类"
      },
      {
         "barCode": "202201271108",
         "skuCode": "STS0007YZUZUVQNX3",
         "skuName": "WZ单品新增测试2",
         "brandCode": "singleproductPN9C9F4KTTT",
         "brandName": "WZ品牌新增测试1",
         "categoryCode": "categoryPXT6VXF24TT",
         "categoryName": "未分类"
      },
      {
         "barCode": "202201271109",
         "skuCode": "STS000784F432ETX3",
         "skuName": "WZ单品新增测试3",
         "brandCode": "singleproductPN9C9F4KTTT",
         "brandName": "WZ品牌新增测试1",
         "categoryCode": "categoryPXT6VXF24TT",
         "categoryName": "未分类"
      }
   ],
   "success": true
}

执行管理

任务审核报表-查询审核审核报表列表

基本信息

Path: /api/lhdg/v2/taskaudit/report/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 否 页数
pageSize 否 页大小
projectCodeOrName 否 项目名称/编号
positionCodeOrName 否 任务----岗位编号/名称
terminalCodeOrName 否 终端编码/名称
brandStoreCodeOrName 否 品牌终端编码/名称
pgCodeOrName 否 触点编码/名称
province 否 省
city 否 市
district 否 区
taskCode 否 任务模块编码
reportDateStart 否 计划执行日期-开始
reportDateEnd 否 计划执行日期-结束
reportTimeStart 否 提交时间-开始
reportTimeEnd 否 提交时间-结束
auditTimeStart 否 审核时间-开始
auditTimeEnd 否 审核时间-结束
auditorCodeOrName 否 审核人名称/编码
operatorGroundCodeOrName 否 经营者(场)姓名/编码

任务审核管理-查询任务审核列表

基本信息

Path: /api/lhdg/v2/taskaudit/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNumber 否 页数
pageSize 否 页大小
projectCodeOrName 否 项目名称/编号
positionCodeOrName 否 任务----岗位编号/名称
terminalCodeOrName 否 终端编码/名称
brandStoreCodeOrName 否 品牌终端编码/名称
pgCodeOrName 否 触点编码/名称
province 否 省
city 否 市
district 否 区
taskCode 否 任务模块编码
reportDateStart 否 计划执行日期-开始
reportDateEnd 否 计划执行日期-结束
reportTimeStart 否 提交时间-开始
reportTimeEnd 否 提交时间-结束

任务审核管理-项目名称编码下拉框

基本信息

Path: /api/lhdg/v2/task/project/lgselect

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
selectValue 否 项目名称

新建任务调查表 步骤2:项目编码查询

基本信息

Path: /survey/findSurveyProjectCodeList

Method: GET

接口描述:

根据当前登录人是经营者权限查询项目编码

请求参数

Query

参数名称 是否必须 示例 备注
projectCode 是 项目编码

返回数据

名称类型是否必须默认值备注其他信息
projectCodestring必须项目编码
projectNamestring必须项目名称

新建任务调查表 步骤2填写调查表信息

基本信息

Path: /survey/createSurveyBasicInfo

Method: POST

接口描述:

调查表的创建第二步,生成调查表基本信息

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
surveyCode text 是 调查表编码
name text 是 调查表名称
description text 是 调查表描述
startDate text 是 开始日期
endDate text 是 结束日期
projectCode text 是 项目编码
status text 是 状态
statusName text 是 状态名称
surveyQuestionCmds text 是 题目列表
index text 是 问题序号
title text 是 问题标题
type text 是 问题类型: 1000为单选题,1001位问答题,1002为图片上传
options text 是 问题选项(单选题)

返回数据

名称类型是否必须默认值备注其他信息
surveyCodestring必须调查表编码
namestring必须调查表名称
descriptionstring必须调查表描述
startDatestring必须开始日期
endDatestring必须结束日期
projectCodestring必须项目编码
statusstring必须状态
statusNamestring必须状态名称
surveyQuestionCmdsobject []必须

item 类型: object

├─ indexstring必须问题序号
├─ titlestring必须问题标题
├─ typestring必须问题类型: 1000为单选题,1001位问答题,1002为图片上传
├─ optionsstring []必须问题选项(单选题)

item 类型: string

├─ 非必须问题选项(单选题)

新建任务调查表-步骤1确定类型

基本信息

Path: /survey/createType

Method: POST

接口描述:

新建任务调查表,步骤一生成调查表编码。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
type text 是 类型

返回数据

名称类型是否必须默认值备注其他信息
datastring必须调查表编码

查询调查表第一步信息

基本信息

Path: /survey/findSurveyType/{code}

Method: GET

接口描述:

根据调查表编码查询步骤条

请求参数

路径参数

参数名称 示例 备注
code

Query

参数名称 是否必须 示例 备注
code 是 调查表编码

返回数据

名称类型是否必须默认值备注其他信息
datastring必须类型
successstring必须成功标识
errMsgstring必须错误信息

步骤条更新

基本信息

Path: /survey/updatePage

Method: POST

接口描述:

根据调查表的创建顺序更新步骤条

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
surveyCode text 是 调查表编码
private Integer stepValue; text 是 步骤条位数

返回数据

名称类型是否必须默认值备注其他信息
datastring非必须返回数据
successboolean必须成功标识
errMsgstring必须错误信息

单品Sdk

批量单品编码查询sku信息

基本信息

Path: /api/singleproduct/v1/productApi/listBatch

Method: POST

接口描述:

功能描述

  • 根据批量单品编码查询单品信息

对接文档

  • 单品列表(不分页)~~~~

接口路径

  • /api/singleproduct/v1/productApi/listBatch

请求参数

参数名 是否必填 类型 说明
list 是 List<String> 单品编码批量

响应示例

{
    "success": true,
    "errorCode": null,
    "errorMessage": null,
    "data": {
      "spCode": "STS000P9QN9P8GPSK",
      "spName": "旺仔牛奶123",
      "spBarCode": "5C235DOP456712",
        "brandCode": "brand324SXSA523",
      "brandName": "喜之郎1",
      "categoryCode": "category36G6JEY6TSN",
      "categoryName": "未分类"
    },
    "traceId": ""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
list text 否 单品编码列表

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorCodestring必须
errorMessagestring必须
dataobject必须
├─ spCodestring必须单品编码
├─ spNamestring必须单品名称
├─ spBarCodestring必须条形码
├─ brandCodestring必须品牌编码
├─ brandNamestring必须品牌名称
├─ categoryCodestring必须品类编码
├─ categoryNamestring必须品类名称
traceIdstring必须

查询单品列表

基本信息

Path: /api/singleproduct/v1/productApi/list

Method: POST

接口描述:

功能描述

  • 查询单品列表

接口路径

  • /api/singleproduct/v1/productApi/list

请求参数

参数名 是否必填 类型 说明
barCode 否 String 条形码
skuCode 否 String 单品编码
skuName 否 String 单品名称
brandName 否 String 品牌名称
categoryName 否 String 品类名称
page 是 Integer 分页
size 是 Integer 分页

响应示例

{
    "success": true,
    "errorCode": null,
    "errorMessage": null,
    "total": 1,
    "data": [
        {
            "barCode": "barCode001",
            "skuCode": "skuCode001",
            "skuName": "skuName001",
            "brandCode": "brandCode001",
            "brandName": "brandName001",
            "categoryCode": "categoryCode001",
            "categoryName": "categoryName001"
        }
    ],
    "traceId": ""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
barCode 否 barCode 条形码
skuCode 否 skuCode 单品编码
skuName 否 skuName 单品名称
brandName 否 brandName 品牌名称
categoryName 否 catName 品类名称
page 是 0 分页
size 是 100 分页

Body

参数名称 参数类型 是否必须 示例 备注
skuCode text 否 单品编码
skuName text 否 单品名称
brandName text 否 品牌名称
categoryName text 否 品类名称
page text 是 分页
size text 是 分页

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorCodenull非必须
errorMessagenull非必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ barCodestring非必须条形码
├─ skuCodestring必须单品编码
├─ skuNamestring必须单品名称
├─ brandCodestring必须品牌编码
├─ brandNamestring必须品牌名称
├─ categoryCodestring必须品类编码
├─ categoryNamestring必须品类名称
traceIdstring必须

查询品牌树

基本信息

Path: /api/singleproduct/v1/brandApi/listAll

Method: GET

接口描述:

功能描述

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

接口路径

  • /api/singleproduct/v1/brandApi/listAll

请求参数

无


响应示例

{
    "success": true,
    "data": [
        {
            "brandCode": "singleproduct3AH8BQE97P",
            "brandName": "A2",
            "brandParCode":null,
            "deep":1,
            "children": [
                {
                    "brandCode": "singleproduct3RGGU3BDXWK",
                    "brandName": "今麦郎",
                    "brandParCode":"singleproduct3AH8BQE97P",
                    "deep":2,
                    "childBrandList": []
                },
                {
                    "brandCode": "singleproductXFZ84J7HBL2K",
                    "brandName": "12",
                    "brandParCode":"singleproduct3AH8BQE97P",
                     "deep":2,
                    "children": [
                        {
                            "brandCode": "singleproductXPCGELPSLL2K",
                            "brandName": "3",
                            "brandParCode":"singleproductXFZ84J7HBL2K",
                             "deep":3,
                            "children": [
                                {
                                    "brandCode": "singleproductXFUKEVARWL2K",
                                    "brandName": "4",
                                    "brandParCode":"singleproductXPCGELPSLL2K",
                                    "deep":4,
                                    "childBrandList": []
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "traceId": "12345678"
}

请求参数

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorCodestring非必须
errorMessagestring非必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ brandCodestring必须品牌编码
├─ brandNamestring必须品牌名称
├─ brandParCodestring必须父品牌编码
├─ deepnumber必须层级
├─ childrenobject []非必须子品牌

item 类型: object

├─ brandCodestring非必须品牌编码
├─ brandNamestring非必须品牌名称
├─ brandParCodestring非必须父品牌编码
├─ deepnumber非必须层级
├─ childrenBrandListobject []非必须子品牌

item 类型: object

traceIdstring必须

查询品类树

基本信息

Path: /api/singleproduct/v1/findAllByCategory

Method: GET

接口描述:

功能描述

  • 查询所有品类,返回树形结构

接口路径

  • /api/singleproduct/v1/findAllByCategory

请求参数

无


响应示例

{
    "success": true,
    "errorCode": null,
    "errorMessage": null,
    "total": 2,
    "data": [
        {
            "categoryCode": "catCode001",
            "categoryName": "品类编码001",
            "categoryParCode": "",
            "deep": 1,
            "children": null
        },
        {
            "categoryCode": "catCode002",
            "categoryName": "品类编码002",
            "categoryParCode": null,
            "deep": 1,
            "children": [
                {
                    "categoryCode": "catCode003",
                    "categoryName": "品类编码003",
                    "categoryParCode": "catCode002",
                    "deep": 2,
                    "children": null
                }
            ]
        }
    ],
    "traceId": ""
}

请求参数

返回数据

名称类型是否必须默认值备注其他信息
successboolean非必须
errorCodenull非必须
errorMessagenull非必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ categoryCodestring必须品类编码
├─ categoryNamestring必须品类名称
├─ categoryParCodestring必须父品类编码
├─ deepnumber必须层级
├─ childrenobject []必须子品类

item 类型: object

├─ categoryCodestring非必须品类编码
├─ categoryNamestring非必须品类名称
├─ categoryParCodestring非必须父品类编码
├─ deepnumber非必须层级
├─ childrenobject []非必须子品类

item 类型: object

traceIdstring非必须

根据单品编码查询该单品是否可用

基本信息

Path: /api/singleproduct/v1/productApi/get

Method: GET

接口描述:

功能描述

  • 根据单品编码查询该单品是否可用

对接文档

  • 单品详情~~~~

接口路径

  • /api/singleproduct/v1/productApi/get

请求参数

参数名 是否必填 类型 说明
skuCode 是 String 单品编码

响应示例

{
    "success": true,
    "errorCode": null,
    "errorMessage": null,
    "data": {
        "status": "0",
        "message": "此单品被禁用"
    },
    "traceId": ""
}

请求参数

Query

参数名称 是否必须 示例 备注
skuCode 是 skuCode 单品编码

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorCodenull非必须
errorMessagenull非必须
dataobject非必须
├─ statusstring必须状态 "0":不可用,"1":可用
├─ messagestring必须不可用原因
traceIdstring必须

根据品牌编码向上查询其所有层级关系

基本信息

Path: /api/singleproduct/v1/brandApi/listParent

Method: GET

接口描述:

功能描述

  • 根据品牌编码向上查询所有父品牌

接口路径

  • api/singleproduct/v1/brandApi/listParent

请求参数

参数名 是否必填 类型 说明
brandCode 是 String 品牌编码

响应示例

{
    "success": true,
    "errorCode": null,
    "errorMessage": null,
    "total": 1,
    "data": [
        {
            "brandCode": "brandCode001",
            "brandName": "品牌编码001",
            "deep": 1
        }
    ],
    "traceId": ""
}





请求参数

Query

参数名称 是否必须 示例 备注
brandCode 是 brandCode001 品牌编码

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorCodestring非必须
errorMessagestring非必须
totalnumber非必须
dataobject []非必须

item 类型: object

├─ brandCodestring必须品牌编码
├─ brandNamestring必须品牌名称
├─ deepnumber必须层级
traceIdstring必须

根据条形码查询该单品详情(导入时校验用)

基本信息

Path: /api/singleproduct/v1/productApi/getByBarCode

Method: GET

接口描述:

功能描述

  • 根据条形码查询该单品详情(导入时校验用)

接口路径

  • /api/singleproduct/v1/productApi/getByBarCode

请求参数

参数名 是否必填 类型 说明
barCode 是 String 条形码

响应示例

{
    "success": true,
    "errorCode": null,
    "errorMessage": null,
    "data": {
        "status": "0",
        "message": "此单品被禁用",
        "skuCode": "单品编码",
        "skuName": "单品名称",
        "brandCode": "品牌编码",
        "brandName": "品牌名称",
        "categoryCode": "品类编码",
        "categoryName": "品类名称"
    },
    "traceId": ""
}

请求参数

Query

参数名称 是否必须 示例 备注
barCode 是 barCode 条形码

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须
errorCodenull非必须
errorMessagenull非必须
dataobject非必须
├─ statusstring必须状态 "0":不可用,"1":可用
├─ messagestring必须不可用原因
├─ skuCodestring必须单品编码
├─ skuNamestring必须单品名称
├─ brandCodestring必须品牌编码
├─ brandNamestring必须品牌名称(层级关系)
├─ categoryCodestring必须品类编码
├─ categoryNamestring必须品类名称(层级关系)
traceIdstring必须

Build by YMFE.