Skip to content

shubifeng/test

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
README.md
README.md
 
 

Repository files navigation

analysis-web swagger（数据平台api）

概览

全局统一约定：1.时间传输用时间戳类型，2.所有金额一律以分为单位进行处理并返回

版本信息

版本 : 1.1.0.RELEASE

联系方式

名字 : 舒笔锋，罗灿江

URI scheme

域名 : localhost:9063
基础路径 : /

标签

  • 云分销app-商品数据 : Report Ware Controller
  • 云分销app-预付款报表 : Report Channel Purchase Controller

路径

预付款提货汇总柱状图

GET /reports/channelPurchase/orderChart

参数

类型 名称 说明 类型 默认值
Query beginTime
必填		 beginTime integer (int64)
Query endTime
必填		 endTime integer (int64)
Query orderType
可选		 预付款订单类型：YUN_MI (1云米产品提货), XIAO_MI (2小米生态链产品提货), MATERIAL (3物料提货) integer (int32) 1
Query timeType
必填		 timeType可选值: day(d按天,默认),month(m按月),quart(q按季),year(y按年) enum (day, month, quart, year)
Query token
必填		 用户会话token string

响应

HTTP代码 说明 类型
200 OK 响应体«渠道预付款统计汇总»
400 业务异常{"timestamp": 0, "status": 0, "path": "url", "error": "msg" } 无内容

消耗

  • application/json

生成

  • */*

标签

  • 云分销app-预付款报表

HTTP请求示例

请求 path
/reports/channelPurchase/orderChart
请求 query
json :
{
  "beginTime" : 0,
  "endTime" : 0,
  "orderType" : 0,
  "timeType" : "string",
  "token" : "string"
}

HTTP响应示例

响应 200
json :
{
  "code" : 0,
  "desc" : "string",
  "result" : {
    "listData" : [ {
      "dataTime" : "string",
      "orderFee" : 0,
      "orderNum" : 0,
      "refundOrderFee" : 0,
      "refundOrderNum" : 0
    } ],
    "totalData" : {
      "orderFee" : 0,
      "orderNum" : 0,
      "refundOrderFee" : 0,
      "refundOrderNum" : 0
    }
  },
  "timestamp" : 0
}

预付款提货报表明细

GET /reports/channelPurchase/orderChartDetail

参数

类型 名称 说明 类型 默认值
Query beginTime
必填		 beginTime integer (int64)
Query endTime
必填		 endTime integer (int64)
Query orderType
可选		 预付款订单类型：YUN_MI (1云米产品提货), XIAO_MI (2小米生态链产品提货), MATERIAL (3物料提货) integer (int32) 1
Query token
必填		 用户会话token string

响应

HTTP代码 说明 类型
200 OK 响应体«List«渠道预付款订单统计详情»»
400 业务异常{"timestamp": 0, "status": 0, "path": "url", "error": "msg" } 无内容

消耗

  • application/json

生成

  • */*

标签

  • 云分销app-预付款报表

HTTP请求示例

请求 path
/reports/channelPurchase/orderChartDetail
请求 query
json :
{
  "beginTime" : 0,
  "endTime" : 0,
  "orderType" : 0,
  "token" : "string"
}

HTTP响应示例

响应 200
json :
{
  "code" : 0,
  "desc" : "string",
  "result" : [ {
    "channelId" : 0,
    "orderFee" : 0,
    "orderNum" : 0,
    "productNum" : 0,
    "channelName" : "string",
    "secondChannel" : "string",
    "rootChannel" : "string"
  } ],
  "timestamp" : 0
}

商品数据：订单商品的销售量，销售额

GET /reports/wares/sales

参数

类型 名称 说明 类型
Query beginTime
必填		 beginTime integer (int64)
Query endTime
必填		 endTime integer (int64)
Query platformType
必填		 平台类型：YUN_MI (1云米商城), MI_JIA (2米家商城), TIAN_MAO (3天猫商城), YU_FU_KUAN (4预付款提货) enum (YUN_MI, MI_JIA, TIAN_MAO, YU_FU_KUAN)
Query timeType
必填		 timeType可选值: day(d按天,默认),month(m按月),quart(q按季),year(y按年) enum (day, month, quart, year)
Query token
必填		 用户会话token string

响应

HTTP代码 说明 类型
200 OK 响应体«List«某个时间内商品的销售量与销售额»»
400 业务异常{"timestamp": 0, "status": 0, "path": "url", "error": "msg" } 无内容

消耗

  • application/json

生成

  • */*

标签

  • 云分销app-商品数据

HTTP请求示例

请求 path
/reports/wares/sales
请求 query
json :
{
  "beginTime" : 0,
  "endTime" : 0,
  "platformType" : "string",
  "timeType" : "string",
  "token" : "string"
}

HTTP响应示例

响应 200
json :
{
  "code" : 0,
  "desc" : "string",
  "result" : [ {
    "data_time" : "string",
    "quantity" : "string",
    "sales" : "string"
  } ],
  "timestamp" : 0
}

商品数据：订单商品的销售量，销售额

GET /reports/wares/salesDetail

参数

类型 名称 说明 类型
Query beginTime
必填		 beginTime integer (int64)
Query endTime
必填		 endTime integer (int64)
Query platformType
必填		 平台类型：YUN_MI (1云米商城), MI_JIA (2米家商城), TIAN_MAO (3天猫商城), YU_FU_KUAN (4预付款提货) enum (YUN_MI, MI_JIA, TIAN_MAO, YU_FU_KUAN)
Query timeType
必填		 timeType可选值: day(d按天,默认),month(m按月),quart(q按季),year(y按年) enum (day, month, quart, year)
Query token
必填		 用户会话token string

响应

HTTP代码 说明 类型
200 OK 响应体«List«某个时间内某一种商品的销售量与销售额»»
400 业务异常{"timestamp": 0, "status": 0, "path": "url", "error": "msg" } 无内容

消耗

  • application/json

生成

  • */*

标签

  • 云分销app-商品数据

HTTP请求示例

请求 path
/reports/wares/salesDetail
请求 query
json :
{
  "beginTime" : 0,
  "endTime" : 0,
  "platformType" : "string",
  "timeType" : "string",
  "token" : "string"
}

HTTP响应示例

响应 200
json :
{
  "code" : 0,
  "desc" : "string",
  "result" : [ {
    "name" : "string",
    "quantity" : 0,
    "sales" : 0
  } ],
  "timestamp" : 0
}

商品数据：商品的库存量，待发货数

GET /reports/wares/stock

参数

类型 名称 说明 类型
Query catalogIds
可选		 商品所属类目id：多个以,分割。https://note.youdao.com/share/?token=6E940ACE238B4D39AADA5F67B20C6B04&gid=42130582 string
Query pendingCountRange
可选		 待出库范围：10,200 表示（开始值,结束值），或者为空值 string
Query prodName
可选		 prodName string
Query saleStatus
可选		 商品在售状态：0预售,1在售 integer (int32)
Query stockCountRange
可选		 库存范围：10,200 表示（开始值,结束值），或者为空值 string
Query token
必填		 用户会话token string

响应

HTTP代码 说明 类型
200 OK 响应体«List«商品的存库与待发货数»»
400 业务异常{"timestamp": 0, "status": 0, "path": "url", "error": "msg" } 无内容

消耗

  • application/json

生成

  • */*

标签

  • 云分销app-商品数据

HTTP请求示例

请求 path
/reports/wares/stock
请求 query
json :
{
  "catalogIds" : "string",
  "pendingCountRange" : "string",
  "prodName" : "string",
  "saleStatus" : 0,
  "stockCountRange" : "string",
  "token" : "string"
}

HTTP响应示例

响应 200
json :
{
  "code" : 0,
  "desc" : "string",
  "result" : [ {
    "name" : "string",
    "pending_count" : 0,
    "stock" : 0,
    "type_name" : "string"
  } ],
  "timestamp" : 0
}

定义

ChannelPurchaseOrderTotalDTO

ChannelPurchaseOrderResp的数据汇总

名称 说明 类型
orderFee
可选		 提货金额
样例 : 0		 integer (int64)
orderNum
可选		 提货订单数
样例 : 0		 integer (int64)
refundOrderFee
可选		 退货退款额
样例 : 0		 integer (int64)
refundOrderNum
可选		 退货退款订单
样例 : 0		 integer (int64)

响应体«List«商品的存库与待发货数»»

名称 说明 类型
code
必填		 状态码
样例 : 0		 integer (int32)
desc
可选		 状态描述
样例 : "string"		 string
result
可选		 返回数据
样例 : [ "[61f16ed3a104d14e18777d63d3d38c53](#61f16ed3a104d14e18777d63d3d38c53)" ]		 < 商品的存库与待发货数 > array
timestamp
可选		 响应时间戳
样例 : 0		 integer (int64)

响应体«List«某个时间内商品的销售量与销售额»»

名称 说明 类型
code
必填		 状态码
样例 : 0		 integer (int32)
desc
可选		 状态描述
样例 : "string"		 string
result
可选		 返回数据
样例 : [ "[e52e877e04cbe4739038e4a2f3406cc1](#e52e877e04cbe4739038e4a2f3406cc1)" ]		 < 某个时间内商品的销售量与销售额 > array
timestamp
可选		 响应时间戳
样例 : 0		 integer (int64)

响应体«List«某个时间内某一种商品的销售量与销售额»»

名称 说明 类型
code
必填		 状态码
样例 : 0		 integer (int32)
desc
可选		 状态描述
样例 : "string"		 string
result
可选		 返回数据
样例 : [ "[900f21f598e484fe615236de8a8e15f3](#900f21f598e484fe615236de8a8e15f3)" ]		 < 某个时间内某一种商品的销售量与销售额 > array
timestamp
可选		 响应时间戳
样例 : 0		 integer (int64)

响应体«List«渠道预付款订单统计详情»»

名称 说明 类型
code
必填		 状态码
样例 : 0		 integer (int32)
desc
可选		 状态描述
样例 : "string"		 string
result
可选		 返回数据
样例 : [ "[760591bfb351570dd3bc1ce434b44ee8](#760591bfb351570dd3bc1ce434b44ee8)" ]		 < 渠道预付款订单统计详情 > array
timestamp
可选		 响应时间戳
样例 : 0		 integer (int64)

响应体«渠道预付款统计汇总»

名称 说明 类型
code
必填		 状态码
样例 : 0		 integer (int32)
desc
可选		 状态描述
样例 : "string"		 string
result
可选		 返回数据
样例 : "[24667b16b4386ce548d58ba280809d4c](#24667b16b4386ce548d58ba280809d4c)"		 渠道预付款统计汇总
timestamp
可选		 响应时间戳
样例 : 0		 integer (int64)

商品的存库与待发货数

名称 说明 类型
name
可选		 商品名称
样例 : "string"		 string
pending_count
可选		 代发货数
样例 : 0		 integer (int32)
stock
可选		 库存数
样例 : 0		 integer (int32)
type_name
可选		 商品类型名称
样例 : "string"		 string

某个时间内商品的销售量与销售额

名称 说明 类型
data_time
可选		 x轴时间
样例 : "string"		 string
quantity
可选		 y轴商品销售量
样例 : "string"		 string
sales
可选		 y轴商品销售额
样例 : "string"		 string

某个时间内某一种商品的销售量与销售额

名称 说明 类型
name
可选		 商品名称
样例 : "string"		 string
quantity
可选		 商品销量
样例 : 0		 integer (int32)
sales
可选		 商品销额
样例 : 0		 integer (int64)

渠道预付款统计汇总

名称 说明 类型
listData
可选		 列表数据
样例 : [ "[41878b656a79712e08a5e35f45061c92](#41878b656a79712e08a5e35f45061c92)" ]		 < 渠道预付款订单统计列表 > array
totalData
可选		 汇总数据
样例 : "[channelpurchaseordertotaldto](#channelpurchaseordertotaldto)"		 ChannelPurchaseOrderTotalDTO

渠道预付款订单统计列表

名称 说明 类型
dataTime
可选		 数据时间
样例 : "string"		 string
orderFee
可选		 提货金额
样例 : 0		 integer (int64)
orderNum
可选		 提货订单数
样例 : 0		 integer (int64)
refundOrderFee
可选		 退货退款额
样例 : 0		 integer (int64)
refundOrderNum
可选		 退货退款订单
样例 : 0		 integer (int64)

渠道预付款订单统计详情

名称 说明 类型
channelId
可选		 渠道ID
样例 : 0		 integer (int64)
channelName
可选		 门店名称
样例 : "string"		 string
orderFee
可选		 提货金额
样例 : 0		 integer (int64)
orderNum
可选		 提货订单数
样例 : 0		 integer (int64)
productNum
可选		 商品数
样例 : 0		 integer (int64)
rootChannel
可选		 城市运营名称
样例 : "string"		 string
secondChannel
可选		 经销商名称
样例 : "string"		 string

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published