analysis-web swagger（数据平台api）

Overview

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

Version information

Version : 1.1.0.RELEASE

Contact information

Contact : 舒笔锋，罗灿江

URI scheme

Host : localhost:9063
BasePath : /

Tags

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

Paths

预付款提货汇总柱状图

GET /reports/channelPurchase/orderChart

Parameters

Type	Name	Description	Schema	Default
Query	beginTime required	beginTime	integer (int64)
Query	endTime required	endTime	integer (int64)
Query	orderType optional	预付款订单类型：YUN_MI (1云米产品提货), XIAO_MI (2小米生态链产品提货), MATERIAL (3物料提货)	integer (int32)	1
Query	timeType required	timeType可选值: day(d按天,默认),month(m按月),quart(q按季),year(y按年). 如 timeType, beginTime, endTime组合使用, beginTime和endTime为时间戳格式	enum (day, month, quart, year)
Query	token required	用户会话token	string

Responses

HTTP Code	Description	Schema
200	OK	接口返回对象的结构«渠道预付款统计汇总»
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• */*

Tags

• 云分销app-预付款报表

预付款提货报表明细

GET /reports/channelPurchase/orderChartDetail

Parameters

Type	Name	Description	Schema	Default
Query	beginTime required	beginTime	integer (int64)
Query	endTime required	endTime	integer (int64)
Query	orderType optional	预付款订单类型：YUN_MI (1云米产品提货), XIAO_MI (2小米生态链产品提货), MATERIAL (3物料提货)	integer (int32)	1
Query	token required	用户会话token	string

Responses

HTTP Code	Description	Schema
200	OK	接口返回对象的结构«List«渠道预付款订单统计详情»»
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• */*

Tags

• 云分销app-预付款报表

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

GET /reports/wares/sales

Parameters

Type	Name	Description	Schema
Query	beginTime required	beginTime	integer (int64)
Query	endTime required	endTime	integer (int64)
Query	platformType required	平台类型：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 required	timeType可选值: day(d按天,默认),month(m按月),quart(q按季),year(y按年). 如 timeType, beginTime, endTime组合使用, beginTime和endTime为时间戳格式	enum (day, month, quart, year)
Query	token required	用户会话token	string

Responses

HTTP Code	Description	Schema
200	OK	接口返回对象的结构«List«某个时间内商品的销售量与销售额»»
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• */*

Tags

• 云分销app-商品数据

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

GET /reports/wares/salesDetail

Parameters

Type	Name	Description	Schema
Query	beginTime required	beginTime	integer (int64)
Query	endTime required	endTime	integer (int64)
Query	platformType required	平台类型：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 required	timeType可选值: day(d按天,默认),month(m按月),quart(q按季),year(y按年). 如 timeType, beginTime, endTime组合使用, beginTime和endTime为时间戳格式	enum (day, month, quart, year)
Query	token required	用户会话token	string

Responses

HTTP Code	Description	Schema
200	OK	接口返回对象的结构«List«某个时间内某一种商品的销售量与销售额»»
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• */*

Tags

• 云分销app-商品数据

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

GET /reports/wares/stock

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	接口返回对象的结构«List«商品的存库与待发货数»»
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

• application/json

Produces

• */*

Tags

• 云分销app-商品数据

Definitions

商品的存库与待发货数

Name	Description	Schema
name optional	商品名称	string
pending_count optional	代发货数	integer (int32)
stock optional	库存数	integer (int32)
type_name optional	商品类型名称	string

接口返回对象的结构«List«商品的存库与待发货数»»

Name	Description	Schema
code required	接口状态码	integer (int32)
desc optional	接口状态描述	string
result optional	返回数据对象	< 商品的存库与待发货数 > array
timestamp optional	当出现错误时,该节点值会存在,返回定位时间戳,可用于查日志位置	integer (int64)

接口返回对象的结构«List«某个时间内商品的销售量与销售额»»

Name	Description	Schema
code required	接口状态码	integer (int32)
desc optional	接口状态描述	string
result optional	返回数据对象	< 某个时间内商品的销售量与销售额 > array
timestamp optional	当出现错误时,该节点值会存在,返回定位时间戳,可用于查日志位置	integer (int64)

接口返回对象的结构«List«某个时间内某一种商品的销售量与销售额»»

Name	Description	Schema
code required	接口状态码	integer (int32)
desc optional	接口状态描述	string
result optional	返回数据对象	< 某个时间内某一种商品的销售量与销售额 > array
timestamp optional	当出现错误时,该节点值会存在,返回定位时间戳,可用于查日志位置	integer (int64)

接口返回对象的结构«List«渠道预付款订单统计详情»»

Name	Description	Schema
code required	接口状态码	integer (int32)
desc optional	接口状态描述	string
result optional	返回数据对象	< 渠道预付款订单统计详情 > array
timestamp optional	当出现错误时,该节点值会存在,返回定位时间戳,可用于查日志位置	integer (int64)

接口返回对象的结构«渠道预付款统计汇总»

Name	Description	Schema
code required	接口状态码	integer (int32)
desc optional	接口状态描述	string
result optional	返回数据对象	渠道预付款统计汇总
timestamp optional	当出现错误时,该节点值会存在,返回定位时间戳,可用于查日志位置	integer (int64)

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

Name	Description	Schema
data_time optional	x轴时间	string
quantity optional	y轴商品销售量	string
sales optional	y轴商品销售额	string

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

Name	Description	Schema
name optional	商品名称	string
quantity optional	商品销量	integer (int32)
sales optional	商品销额	integer (int64)

渠道预付款统计汇总

Name	Description	Schema
listData optional	列表数据	< 渠道预付款订单统计列表 > array
totalData optional	汇总数据	渠道预付款订单统计汇总

渠道预付款订单统计列表

Name	Description	Schema
dataTime optional	数据时间	string
orderFee optional	提货金额	integer (int64)
orderNum optional	提货订单数	integer (int64)
refundOrderFee optional	退货退款额	integer (int64)
refundOrderNum optional	退货退款订单	integer (int64)

渠道预付款订单统计汇总

ChannelPurchaseOrderResp的数据汇总

Name	Description	Schema
orderFee optional	提货金额	integer (int64)
orderNum optional	提货订单数	integer (int64)
refundOrderFee optional	退货退款额	integer (int64)
refundOrderNum optional	退货退款订单	integer (int64)

渠道预付款订单统计详情

Name	Description	Schema
channelId optional	渠道ID	integer (int64)
channelName optional	门店名称	string
orderFee optional	提货金额	integer (int64)
orderNum optional	提货订单数	integer (int64)
productNum optional	商品数	integer (int64)
rootChannel optional	城市运营名称	string
secondChannel optional	经销商名称	string