营业数据¶
接口说明¶
二维火系统提供接口,第三方系统可通过此接口查询指定商户订单统计数据。
二维火商户和第三方系统商户进行id匹配;
二维火提供商户营业数据接口,第三方系统可通过此接口获取商户营业数据
- 订单统计数据
- 订单来源数据
- 订单支付数据
接口定义¶
请求URL:
http://{servename}/router(二维火提供查询)
1、订单数据统计报表(按天)¶
method="dfire.shop.day.statistic.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计日期 | currDate | String | N | 20161001 |
传递form表单参数实例:
appKey: | cdc08577b61942442aa89390dacb25ad |
---|---|
timestamp: | 1476255107097 |
sign: | DF0719FCD2B0CE188307595BB39F5DE9488DD57E |
v: | 1.0 |
method: | dfire.shop.day.statistic.data |
entityId: | 99000487 |
currDate: | 20161001 |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单日期 | orderDate | String | N | |
订单数量 | orderCount | Integer | N | 0 |
无效订单数量 | orderInvalidCount | Integer | N | 0 |
就餐人数 | mealsCount | Integer | N | 0 |
原始金额 | sourceAmount | BigDecimal | N | 0.00 |
实收金额 | actualAmount | BigDecimal | N | 0.00 |
应收金额 | finalAmount | BigDecimal | N | 0.00 |
折扣金额 | discountAmount | BigDecimal | N | 0.00 |
损益金额 | profitLossAmount | BigDecimal | N | 0.00 |
人均实收金额 | actualAmountAvg | BigDecimal | N | 0.00 |
返回参数 实例:
{
"success": true,
"model": {
"entityId": "99000487",
"orderDate": "20150321",
"orderCount": 10,
"orderInvalidCount": 0,
"mealsCount": 68,
"sourceAmount": 4976.78,
"actualAmount": 4328,
"finalAmount": 0,
"discountAmount": 248.31,
"profitLossAmount": -0.47,
"actualAmountAvg": 69.53
},
"totalRecord": 0
}
2、订单数据统计报表(按月)¶
method="dfire.shop.month.statistic.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计月份 | currMonth | String | N | 201610 |
传递form表单参数实例:
method: | dfire.shop.month.statistic.data |
---|---|
appKey: | cdc08577b61942442aa89390dacb25ad |
v: | 1.0 |
timestamp: | 1476928755336 |
entityId: | 3344 |
currMonth: | 201607 |
sign: | 336AF1B207104358FF80F0A364D1EEDC5702C5C5 |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单月份 | orderMonth | String | N | |
订单数量 | orderCount | Integer | N | 0 |
无效订单数量 | orderInvalidCount | Integer | N | 0 |
就餐人数 | mealsCount | Integer | N | 0 |
原始金额 | sourceAmount | BigDecimal | N | 0.00 |
实收金额 | actualAmount | BigDecimal | N | 0.00 |
应收金额 | finalAmount | BigDecimal | N | 0.00 |
折扣金额 | discountAmount | BigDecimal | N | 0.00 |
损益金额 | profitLossAmount | BigDecimal | N | 0.00 |
人均实收金额 | actualAmountAvg | BigDecimal | N | 0.00 |
返回参数 实例:
{
"success": true,
"model": {
"entityId": "99180079",
"orderMonth": "201607",
"orderCount": 18,
"orderInvalidCount": 0,
"mealsCount": 110,
"sourceAmount": 4197.64,
"finalAmount": 0.00,
"actualAmount": 4010.08,
"discountAmount": 187.56,
"profitLossAmount": 0.00,
"actualAmountAvg": 36.46
},
"totalRecord": 0
}
3、订单来源统计报表(按天)¶
method="dfire.shop.day.platform.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计日期 | currDate | String | N | 20161001 |
传递form表单参数实例:
method: | dfire.shop.day.platform.data |
---|---|
appKey: | cdc08577b61942442aa89390dacb25ad |
v: | 1.0 |
timestamp: | 1476931638367 |
entityId: | 3344 |
currDate: | 20160517 |
sign: | CD32A45E03B029045661FCC84CC18B9C6B434F50 |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单日期 | orderDate | String | N | |
订单数量 | orderCount | Integer | N | 0 |
无效订单数量 | orderInvalidCount | Integer | N | 0 |
就餐人数 | mealsCount | Integer | N | 0 |
原始金额 | sourceAmount | BigDecimal | N | 0.00 |
实收金额 | actualAmount | BigDecimal | N | 0.00 |
应收金额 | finalAmount | BigDecimal | N | 0.00 |
折扣金额 | discountAmount | BigDecimal | N | 0.00 |
损益金额 | profitLossAmount | BigDecimal | N | 0.00 |
人均实收金额 | actualAmountAvg | BigDecimal | N | 0.00 |
订单来源 | platform | String | N | 0 |
返回参数 实例:
{
"success": true,
"model": [{
"entityId": "3344",
"orderDate": "20160517",
"orderCount": 4,
"orderInvalidCount": 0,
"mealsCount": 24,
"sourceAmount": 675.00,
"actualAmount": 653.00,
"finalAmount": 0.00,
"discountAmount": 22.00,
"profitLossAmount": 0.00,
"actualAmountAvg": 27.21,
"platform": "0"
}],
"totalRecord": 0
}
4、订单来源统计报表(按月)¶
method="dfire.shop.month.platform.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计月份 | currMonth | String | N | 201610 |
传递form表单参数实例:
method: | dfire.shop.month.platform.data |
---|---|
appKey: | cdc08577b61942442aa89390dacb25ad |
v: | 1.0 |
timestamp: | 1476931741560 |
entityId: | 3344 |
currMonth: | 201606 |
sign: | AC574EB7525AEC486BF4558BBCD60DA2E0AEE1DE |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单月份 | orderMonth | String | N | |
订单数量 | orderCount | Integer | N | 0 |
无效订单数量 | orderInvalidCount | Integer | N | 0 |
就餐人数 | mealsCount | Integer | N | 0 |
原始金额 | sourceAmount | BigDecimal | N | 0.00 |
实收金额 | actualAmount | BigDecimal | N | 0.00 |
应收金额 | finalAmount | BigDecimal | N | 0.00 |
折扣金额 | discountAmount | BigDecimal | N | 0.00 |
损益金额 | profitLossAmount | BigDecimal | N | 0.00 |
人均实收金额 | actualAmountAvg | BigDecimal | N | 0.00 |
订单来源 | platform | String | N | 0 |
返回参数 实例:
{
"success": true,
"model": [{
"entityId": "3344",
"orderMonth": "201606",
"orderCount": 35,
"orderInvalidCount": 0,
"mealsCount": 167,
"sourceAmount": 3841.19,
"finalAmount": 0.00,
"actualAmount": 3801.15,
"discountAmount": 40.04,
"profitLossAmount": 0.00,
"actualAmountAvg": 22.76,
"platform": "0"
}],
"totalRecord": 0
}
5、订单支付统计报表(按天)¶
method="dfire.shop.day.payment.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计日期 | currDate | String | N | 20161001 |
传递form表单参数实例:
method: | dfire.shop.day.payment.data |
---|---|
appKey: | cdc08577b61942442aa89390dacb25ad |
v: | 1.0 |
timestamp: | 1476931810229 |
entityId: | 3344 |
currDate: | 20160512 |
sign: | EEBC25B835F6B428AEB43CD5C0A11E272D93E2C4 |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单日期 | orderDate | String | N | |
支付方式 | payKindName | String | N | 0 |
支付金额 | payAmount | BigDecimal | N | 0.00 |
是否计入营业额 | isInclude | Integer | N | 0 |
返回参数 实例:
{
"success": true,
"model": [{
"entityId": "3344",
"orderDate": "20160512",
"payKindName": "现金",
"payAmount": 232.01,
"isInclude": 0
}],
"totalRecord": 0
}
6、订单支付统计报表(按月)¶
method="dfire.shop.month.payment.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计月份 | currMonth | String | N | 201610 |
传递form表单参数实例:
method: | dfire.shop.month.payment.data |
---|---|
appKey: | cdc08577b61942442aa89390dacb25ad |
v: | 1.0 |
timestamp: | 1476931914091 |
entityId: | 3344 |
currMonth: | 201607 |
sign: | 98672F18B42BE3B2C6CB4D43401FA83095EF0525 |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单月份 | orderMonth | String | N | |
支付方式 | payKindName | String | N | 0 |
支付金额 | payAmount | BigDecimal | N | 0.00 |
是否计入营业额 | isInclude | Integer | N | 0 |
返回参数 实例:
{
"success": true,
"model": [
{
"entityId": "3344",
"orderMonth": "201607",
"payKindName": "[红包]",
"payAmount": 50.00,
"isInclude": 0
},
{
"entityId": "3344",
"orderMonth": "201607",
"payKindName": "储值卡",
"payAmount": 220.68,
"isInclude": 0
},
{
"entityId": "3344",
"orderMonth": "201607",
"payKindName": "现金",
"payAmount": 3739.40,
"isInclude": 0
}
],
"totalRecord": 0
}
7、点菜数据统计报表(按天)¶
method="dfire.shop.day.memu.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计日期 | currDate | String | N | 20161001 |
传递form表单参数实例:
appKey: | cdc08577b61942442aa89390dacb25ad |
---|---|
timestamp: | 1476255107097 |
sign: | DF0719FCD2B0CE188307595BB39F5DE9488DD57E |
v: | 1.0 |
method: | dfire.shop.day.memu.data |
entityId: | 99000487 |
currDate: | 20161001 |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单日期 | currDate | String | N | |
门店名称 | shopName | String | N | 0 |
菜类 | kindmenuName | String | N | 0 |
菜名 | menuName | String | N | 0 |
数量 | num | int | N | 0 |
销售金额 | fee | BigDecimal | N | 0.00 |
折后金额 | ratioFee | BigDecimal | N | 0.00 |
返回参数 实例:
{
"success": true,
"model": [
{
"entityId": "3344",
"currDate": "2017-03-04",
"shopName": "城市店",
"kindmenuName": "扒类",
"menuName": "特级T骨",
"num": 1,
"fee": 68,
"ratioFee": 68
}
],
"totalRecord": 0
}
7、点菜数据统计报表(按月)¶
method="dfire.shop.month.memu.data"
传递参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 举例 |
---|---|---|---|---|
门店id | entityId | String | N | 所属门店 |
统计月份 | currMonth | String | N | 201610 |
传递form表单参数实例:
appKey: | cdc08577b61942442aa89390dacb25ad |
---|---|
timestamp: | 1476255107097 |
sign: | DF0719FCD2B0CE188307595BB39F5DE9488DD57E |
v: | 1.0 |
method: | dfire.shop.month.memu.data |
entityId: | 99000487 |
currMonth: | 201610 |
返回参数为:
字段说明 | 字段名 | 类型 | 可空(Y/N) | 默认值 |
---|---|---|---|---|
实体Id | entityId | String | N | |
订单日期 | currDate | String | N | |
门店名称 | shopName | String | N | 0 |
菜类 | kindmenuName | String | N | 0 |
菜名 | menuName | String | N | 0 |
数量 | num | int | N | 0 |
销售金额 | fee | BigDecimal | N | 0.00 |
折后金额 | ratioFee | BigDecimal | N | 0.00 |
返回参数 实例:
{
"success": true,
"model": [
{
"entityId": "3344",
"currDate": "2017-03-04",
"shopName": "城市店",
"kindmenuName": "扒类",
"menuName": "特级T骨",
"num": 1,
"fee": 68,
"ratioFee": 68
}
],
"totalRecord": 0
}