2021-09-23

**京东返现**

**简介**:京东返现

**HOST**:localhost:8888

**联系人**:京东

**Version**:1.0

**接口路径**:/v2/api-docs?group=2.X版本

# 掌柜管家需求接口

## settlement

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/addCashbackSettlement`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"activeId": 0,

"createBy": 0,

"createTime": "",

"delFlag": 0,

"id": 0,

"orderId": "",

"settlementAmount": 0,

"settlementTime": "",

"transactionConfirmed": 0,

"transactionId": 0,

"updateBy": 0,

"updateTime": ""

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|req| req  | body | true |CashbackSettlement  | CashbackSettlement  |

**schema属性说明**

**CashbackSettlement**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| 活动id  | body | false |integer(int64)  |    |

|createBy| 创建人  | body | false |integer(int64)  |    |

|createTime| 创建时间  | body | false |string(date-time)  |    |

|delFlag| 删除标记  | body | false |integer(int32)  |    |

|id| 主键id  | body | false |integer(int64)  |    |

|orderId| 数组型的订单id  | body | false |string  |    |

|settlementAmount| 结算金额  | body | false |number  |    |

|settlementTime| 结算时间  | body | false |string(date-time)  |    |

|transactionConfirmed| 转账状态(0:new settlement,1: transaction confirmed)  | body | false |integer(int32)  |    |

|transactionId| 转账卡号  | body | false |integer(int64)  |    |

|updateBy| 更新人  | body | false |integer(int64)  |    |

|updateTime| 更新时间  | body | false |string(date-time)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 确认转账

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/addCashbackTransferConfirmation`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"createBy": 0,

"createTime": "",

"delFlag": 0,

"id": 0,

"payerName": "",

"serialNumberBank": "",

"settlementId": 0,

"settlementTime": "",

"updateBy": 0,

"updateTime": ""

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|cashbackTransferConfirmation| cashbackTransferConfirmation  | body | true |CashbackTransferConfirmation  | CashbackTransferConfirmation  |

**schema属性说明**

**CashbackTransferConfirmation**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|createBy| 创建人  | body | false |integer(int64)  |    |

|createTime| 创建时间  | body | false |string(date-time)  |    |

|delFlag| 删除标记  | body | false |integer(int32)  |    |

|id| 主键id  | body | false |integer(int64)  |    |

|payerName| 转款人姓名  | body | false |string  |    |

|serialNumberBank| 流水账号  | body | false |string  |    |

|settlementId| 结算ID  | body | false |integer(int64)  |    |

|settlementTime| 转账时间  | body | false |string(date-time)  |    |

|updateBy| 更新人  | body | false |integer(int64)  |    |

|updateTime| 更新时间  | body | false |string(date-time)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## all order size/所有订单tab页总条数

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/cashBackAllOrderSize/{activeId}`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| activeId  | path | true |integer  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## cash back主页面>右侧:活动详情/活动进度

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/joinActive`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| 活动id  | query | true |string  |    |

|shopId| 店铺id  | query | true |string  |    |

|shopName| 店铺名称  | query | true |string  |    |

**响应数据**:

```json

{

"activeTime": "",

"cashbackState": 0,

"createErp": "",

"endTime": "",

"id": 0,

"name": "",

"startTime": ""

}

```

**响应参数说明**:

| 参数名称        | 说明                            |    类型 |  schema |

| ------------ | -------------------|-------|----------- |

|activeTime| 活动时间  |string  |    |

|cashbackState| 活动状态  |integer(int32)  | integer(int32)  |

|createErp| 创建人erp  |string  |    |

|endTime|  |string  |    |

|id| 活动id  |integer(int64)  | integer(int64)  |

|name| 活动名称  |string  |    |

|startTime|  |string  |    |

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  |活动状态查询列表|

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## view the orders of settlement

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashBackSettlementById/{id}`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|id| id  | path | true |integer  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## view the orders of settlement 1/分页按钮

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashBackSettlementByPage`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"id": 0,

"pageNum": 0,

"pageSize": 0

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|req| req  | body | true |SettlementOrderPageReq  | SettlementOrderPageReq  |

**schema属性说明**

**SettlementOrderPageReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|id|  | body | false |integer(int64)  |    |

|pageNum| 当前页  | body | false |integer(int32)  |    |

|pageSize| 每页显示几条  | body | false |integer(int32)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## waiting for settlement/待结算

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPage`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"activeId": 0,

"endTime": "",

"orderType": 0,

"pageNum": 0,

"pageSize": 0,

"startTime": ""

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|req| req  | body | true |OrderStatusReq  | OrderStatusReq  |

**schema属性说明**

**OrderStatusReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| 活动id  | body | false |integer(int64)  |    |

|endTime| 订单结束时间  | body | false |string(date-time)  |    |

|orderType| 订单类型  | body | false |integer(int32)  |    |

|pageNum| 当前页  | body | false |integer(int32)  |    |

|pageSize| 每页显示几条  | body | false |integer(int32)  |    |

|startTime| 订单开始时间  | body | false |string(date-time)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## all order/所有订单

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPageAllOrder`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"activeId": 0,

"endTime": "",

"orderType": 0,

"pageNum": 0,

"pageSize": 0,

"startTime": ""

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|req| req  | body | true |OrderStatusReq  | OrderStatusReq  |

**schema属性说明**

**OrderStatusReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| 活动id  | body | false |integer(int64)  |    |

|endTime| 订单结束时间  | body | false |string(date-time)  |    |

|orderType| 订单类型  | body | false |integer(int32)  |    |

|pageNum| 当前页  | body | false |integer(int32)  |    |

|pageSize| 每页显示几条  | body | false |integer(int32)  |    |

|startTime| 订单开始时间  | body | false |string(date-time)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 已转账的订单

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPageTransfer`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"activeId": 0,

"endTime": "",

"orderType": 0,

"pageNum": 0,

"pageSize": 0,

"startTime": ""

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|req| req  | body | true |OrderStatusReq  | OrderStatusReq  |

**schema属性说明**

**OrderStatusReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| 活动id  | body | false |integer(int64)  |    |

|endTime| 订单结束时间  | body | false |string(date-time)  |    |

|orderType| 订单类型  | body | false |integer(int32)  |    |

|pageNum| 当前页  | body | false |integer(int32)  |    |

|pageSize| 每页显示几条  | body | false |integer(int32)  |    |

|startTime| 订单开始时间  | body | false |string(date-time)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 已转账的订单总条数

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPageTransferSize/{activeId}`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| activeId  | path | true |integer  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## cash back主页面>右侧:活动详情/活动进度

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashbackActiveDetail`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| 活动id  | query | true |string  |    |

|activeState| 活动状态(2未开始,3已发布,4进行中,5已结束))  | query | true |string  |    |

|joinState| 是否参加活动(1:参加,2未参加)  | query | true |string  |    |

|shopId| 店铺id  | query | true |string  |    |

**响应数据**:

```json

{

"activeTime": "",

"cashbackState": 0,

"createErp": "",

"endTime": "",

"id": 0,

"name": "",

"startTime": ""

}

```

**响应参数说明**:

| 参数名称        | 说明                            |    类型 |  schema |

| ------------ | -------------------|-------|----------- |

|activeTime| 活动时间  |string  |    |

|cashbackState| 活动状态  |integer(int32)  | integer(int32)  |

|createErp| 创建人erp  |string  |    |

|endTime|  |string  |    |

|id| 活动id  |integer(int64)  | integer(int64)  |

|name| 活动名称  |string  |    |

|startTime|  |string  |    |

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  |活动状态查询列表|

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## cash back主页面>左侧:活动列表

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashbackActiveList`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeState| 0:onGonging,1:history  | query | true |string  |    |

|shopId| 店铺id  | query | true |string  |    |

**响应数据**:

```json

{

"activeId": 0,

"activeTime": "",

"cashbackRule": "",

"cashbackState": 0,

"endTime": "",

"joinState": 0,

"name": "",

"newUserCount": 0,

"point": "",

"progress": "",

"progressAmount": 0,

"startTime": ""

}

```

**响应参数说明**:

| 参数名称        | 说明                            |    类型 |  schema |

| ------------ | -------------------|-------|----------- |

|activeId| 活动id  |integer(int64)  | integer(int64)  |

|activeTime| 活动时间  |string  |    |

|cashbackRule| 活动规则(0:order cashback,1:new user cashback,order cashback & 2:new user cashback)  |string  |    |

|cashbackState| 活动状态(1未发布,2未开始,3已发布,4进行中,5已结束)  |integer(int32)  | integer(int32)  |

|endTime| 活动结束时间  |string(date-time)  | string(date-time)  |

|joinState| 参加标识(1:参加,2未参加)  |integer(int32)  | integer(int32)  |

|name| 活动名称  |string  |    |

|newUserCount| 用户返现:显示已有用户数量(进行中,且参加了活动才有此信息)  |integer(int32)  | integer(int32)  |

|point| 活动亮点  |string  |    |

|progress| 订单返现:展示进度条(进行中,且参加了活动才有此信息)  |string  |    |

|progressAmount| 当前完成总金额  |number  |    |

|startTime| 活动开始时间  |string(date-time)  | string(date-time)  |

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  |ActiveListResponse|

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## all order and waiting for settlement/待结算页面列表

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashbackSettlementByPage`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"activeId": 0,

"endTime": "",

"orderType": 0,

"pageNum": 0,

"pageSize": 0,

"startTime": ""

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|req| req  | body | true |OrderStatusReq  | OrderStatusReq  |

**schema属性说明**

**OrderStatusReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| 活动id  | body | false |integer(int64)  |    |

|endTime| 订单结束时间  | body | false |string(date-time)  |    |

|orderType| 订单类型  | body | false |integer(int32)  |    |

|pageNum| 当前页  | body | false |integer(int32)  |    |

|pageSize| 每页显示几条  | body | false |integer(int32)  |    |

|startTime| 订单开始时间  | body | false |string(date-time)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

# 活动设置

## 新增活动设置

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/addCashbackActive`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"cashbackActive": {

"area": "",

"cashbackRule": 0,

"cashbackState": 0,

"consumerType": 0,

"createBy": 0,

"createTime": "",

"delFlag": 0,

"endTime": "",

"id": 0,

"name": "",

"orderType": 0,

"payType": 0,

"point": "",

"startTime": "",

"timeType": 0,

"updateBy": 0,

"updateTime": ""

},

"cashbackActiveRuleList": [

{

"cashbackActiveId": 0,

"cashbackAmount": 0,

"cashbackCeiling": 0,

"cashbackCompany": "",

"consumerNumber": 0,

"endAmount": 0,

"id": 0,

"ruleStep": 0,

"startAmount": 0

}

]

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeReq| activeReq  | body | true |ActiveReq  | ActiveReq  |

**schema属性说明**

**ActiveReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|cashbackActive|  | body | false |CashbackActive  | CashbackActive  |

|cashbackActiveRuleList|  | body | false |array  | 返现活动规则详情  |

**CashbackActive**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|area| 门店范围:必选,单选;分为全部门店和部分门店(选择部分门店后,该活动只能被选中门店查看。选择部门门店时,需要用户上传excel文件,确定活动包含的门店范围)  | body | false |string  |    |

|cashbackRule| 0:订单返现1:用户返现,2:订单&用户  | body | false |integer(int32)  |    |

|cashbackState| 活动状态(1未发布,2未开始,3已发布,4进行中,5已结束)  | body | false |integer(int32)  |    |

|consumerType| 用户类型: 必选,多选;分为门店会员和非门店会员  | body | false |integer(int64)  |    |

|createBy| 创建人  | body | false |integer(int64)  |    |

|createTime| 创建时间  | body | false |string(date-time)  |    |

|delFlag| 删除标记  | body | false |integer(int32)  |    |

|endTime| 结束时间:必填,开始时间:默认当前时间,精确至时分秒,活动不可以早于当前时间;结束时间:默认时分秒为23:59:59,与开始时间最大间隔为90天  | body | false |string(date-time)  |    |

|id| 主键id  | body | false |integer(int64)  |    |

|name| 活动名称:必填,不为空,语言特殊字符等无需校验,最多200个字符  | body | false |string  |    |

|orderType|  订单类型:必选,单选;分为线下门店订单和线上JD Central订单  | body | false |integer(int64)  |    |

|payType| 支付类型:必选,多选;分为现金,POS,其他  | body | false |integer(int64)  |    |

|point| 活动亮点:非必填,语言特殊字符等无需校验,最多100个字符  | body | false |string  |    |

|startTime| 开始时间:必填,开始时间:默认当前时间,精确至时分秒,活动不可以早于当前时间;结束时间:默认时分秒为23:59:59,与开始时间最大间隔为90天  | body | false |string(date-time)  |    |

|timeType| 时间口径:必选,单选;分为下单时间和完成时间;下单时间:订单在JDC侧的生成时间完成时间:订单在JDC侧的完成时间(COD订单需要在财务对账之后完成)  | body | false |integer(int64)  |    |

|updateBy| 更新人  | body | false |integer(int64)  |    |

|updateTime| 更新时间  | body | false |string(date-time)  |    |

**返现活动规则详情**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|cashbackActiveId| 返现活动id  | body | false |integer(int64)  |    |

|cashbackAmount| 返现金额/比例  | body | false |number  |    |

|cashbackCeiling| 返现上限  | body | false |number  |    |

|cashbackCompany| 泰铢/%  | body | false |string  |    |

|consumerNumber| 新用户数  | body | false |integer(int64)  |    |

|endAmount| 结束金额  | body | false |number  |    |

|id| 主键id  | body | false |integer(int64)  |    |

|ruleStep| 规则阶梯(1:一阶梯,2:二阶梯,3三阶梯,4:用户返现)  | body | false |integer(int64)  |    |

|startAmount| 起始金额  | body | false |number  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 返现活动查询 > 活动数据查询 > 查看详情

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/cashbackActiveDetail/{id}`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|id| 活动id  | query | true |string  |    |

**响应数据**:

```json

{

"activeId": 0,

"conformPart": 0,

"expectedAmount": 0,

"expectedReturn": 0,

"joinTime": "",

"storeId": 0,

"storeName": ""

}

```

**响应参数说明**:

| 参数名称        | 说明                            |    类型 |  schema |

| ------------ | -------------------|-------|----------- |

|activeId| 活动id  |integer(int64)  | integer(int64)  |

|conformPart| 符合参与  |number  |    |

|expectedAmount| 当前进度  |number  |    |

|expectedReturn| 预计返现金额  |number  |    |

|joinTime| 报名时间  |string(date-time)  | string(date-time)  |

|storeId| 店铺id  |integer(int64)  | integer(int64)  |

|storeName| 店铺名称  |string  |    |

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  |ActiveStoreResponse|

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 活动发布

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/cashbackActivePublish/{id}`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|id| 活动id  | query | true |string  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 活动删除

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/cashbackActiveRemove/{id}`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|id| 活动id  | query | true |string  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 返现活动查询 > 活动数据查询 > 查看详情--查看订单

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/cashbackOrderList`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| activeId  | query | false |integer  |    |

|storeId| storeId  | query | false |integer  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 校验与活动叠加时段是否有同订单类型的活动已经创建

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/checkCashbackActive`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"cashbackActive": {

"area": "",

"cashbackRule": 0,

"cashbackState": 0,

"consumerType": 0,

"createBy": 0,

"createTime": "",

"delFlag": 0,

"endTime": "",

"id": 0,

"name": "",

"orderType": 0,

"payType": 0,

"point": "",

"startTime": "",

"timeType": 0,

"updateBy": 0,

"updateTime": ""

},

"cashbackActiveRuleList": [

{

"cashbackActiveId": 0,

"cashbackAmount": 0,

"cashbackCeiling": 0,

"cashbackCompany": "",

"consumerNumber": 0,

"endAmount": 0,

"id": 0,

"ruleStep": 0,

"startAmount": 0

}

]

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeReq| activeReq  | body | true |ActiveReq  | ActiveReq  |

**schema属性说明**

**ActiveReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|cashbackActive|  | body | false |CashbackActive  | CashbackActive  |

|cashbackActiveRuleList|  | body | false |array  | 返现活动规则详情  |

**CashbackActive**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|area| 门店范围:必选,单选;分为全部门店和部分门店(选择部分门店后,该活动只能被选中门店查看。选择部门门店时,需要用户上传excel文件,确定活动包含的门店范围)  | body | false |string  |    |

|cashbackRule| 0:订单返现1:用户返现,2:订单&用户  | body | false |integer(int32)  |    |

|cashbackState| 活动状态(1未发布,2未开始,3已发布,4进行中,5已结束)  | body | false |integer(int32)  |    |

|consumerType| 用户类型: 必选,多选;分为门店会员和非门店会员  | body | false |integer(int64)  |    |

|createBy| 创建人  | body | false |integer(int64)  |    |

|createTime| 创建时间  | body | false |string(date-time)  |    |

|delFlag| 删除标记  | body | false |integer(int32)  |    |

|endTime| 结束时间:必填,开始时间:默认当前时间,精确至时分秒,活动不可以早于当前时间;结束时间:默认时分秒为23:59:59,与开始时间最大间隔为90天  | body | false |string(date-time)  |    |

|id| 主键id  | body | false |integer(int64)  |    |

|name| 活动名称:必填,不为空,语言特殊字符等无需校验,最多200个字符  | body | false |string  |    |

|orderType|  订单类型:必选,单选;分为线下门店订单和线上JD Central订单  | body | false |integer(int64)  |    |

|payType| 支付类型:必选,多选;分为现金,POS,其他  | body | false |integer(int64)  |    |

|point| 活动亮点:非必填,语言特殊字符等无需校验,最多100个字符  | body | false |string  |    |

|startTime| 开始时间:必填,开始时间:默认当前时间,精确至时分秒,活动不可以早于当前时间;结束时间:默认时分秒为23:59:59,与开始时间最大间隔为90天  | body | false |string(date-time)  |    |

|timeType| 时间口径:必选,单选;分为下单时间和完成时间;下单时间:订单在JDC侧的生成时间完成时间:订单在JDC侧的完成时间(COD订单需要在财务对账之后完成)  | body | false |integer(int64)  |    |

|updateBy| 更新人  | body | false |integer(int64)  |    |

|updateTime| 更新时间  | body | false |string(date-time)  |    |

**返现活动规则详情**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|cashbackActiveId| 返现活动id  | body | false |integer(int64)  |    |

|cashbackAmount| 返现金额/比例  | body | false |number  |    |

|cashbackCeiling| 返现上限  | body | false |number  |    |

|cashbackCompany| 泰铢/%  | body | false |string  |    |

|consumerNumber| 新用户数  | body | false |integer(int64)  |    |

|endAmount| 结束金额  | body | false |number  |    |

|id| 主键id  | body | false |integer(int64)  |    |

|ruleStep| 规则阶梯(1:一阶梯,2:二阶梯,3三阶梯,4:用户返现)  | body | false |integer(int64)  |    |

|startAmount| 起始金额  | body | false |number  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 导出部分门店的活动id

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/exportExcel`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId| activeId  | query | false |integer  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 活动数据查询详情

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/queryCashbackActive/{id}`

**请求方式**:`GET`

**consumes**:``

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|id| id  | path | true |integer  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 活动列表分页查询

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/queryCashbackActiveByPage`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"activeBeginTime": "",

"activeEndTime": "",

"cashbackState": 0,

"createErp": "",

"id": 0,

"pageNum": 0,

"pageSize": 0

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|cashbackActiveListQuery| cashbackActiveListQuery  | body | true |活动状态查询页面查询条件  | 活动状态查询页面查询条件  |

**schema属性说明**

**活动状态查询页面查询条件**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeBeginTime| 活动开始时间  | body | false |string  |    |

|activeEndTime| 活动结束时间  | body | false |string  |    |

|cashbackState| 活动状态(未发布,未开始,已发布,进行中,已结束)  | body | false |integer(int32)  |    |

|createErp| 活动创建erp  | body | false |string  |    |

|id| 活动id  | body | false |integer(int64)  |    |

|pageNum| 当前页  | body | false |integer(int32)  |    |

|pageSize| 每页显示几条  | body | false |integer(int32)  |    |

**响应数据**:

```json

{

"activeTime": "",

"cashbackState": 0,

"createErp": "",

"endTime": "",

"id": 0,

"name": "",

"startTime": ""

}

```

**响应参数说明**:

| 参数名称        | 说明                            |    类型 |  schema |

| ------------ | -------------------|-------|----------- |

|activeTime| 活动时间  |string  |    |

|cashbackState| 活动状态  |integer(int32)  | integer(int32)  |

|createErp| 创建人erp  |string  |    |

|endTime|  |string  |    |

|id| 活动id  |integer(int64)  | integer(int64)  |

|name| 活动名称  |string  |    |

|startTime|  |string  |    |

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  |活动状态查询列表|

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 活动数据查询页面

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/queryCashbackActiveDataPage`

**请求方式**:`POST`

**consumes**:`["application/json"]`

**produces**:`["*/*"]`

**请求示例**:

```json

{

"activeId": 0,

"createErp": 0,

"pageNum": 0,

"pageSize": 0,

"status": 0

}

```

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeDataReq| activeDataReq  | body | true |CashbackActiveDataReq  | CashbackActiveDataReq  |

**schema属性说明**

**CashbackActiveDataReq**

| 参数名称        | 说明    |    in |  是否必须  |  类型  |  schema |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|activeId|  | body | false |integer(int64)  |    |

|createErp|  | body | false |integer(int64)  |    |

|pageNum| 当前页  | body | false |integer(int32)  |    |

|pageSize| 每页显示几条  | body | false |integer(int32)  |    |

|status|  | body | false |integer(int32)  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

## 读取 Excel(指定某个 sheet)

**接口说明**:

**接口地址**:`/cashback/storesaas/cashback/active/uploadExcel`

**请求方式**:`POST`

**consumes**:`["multipart/form-data"]`

**produces**:`["*/*"]`

**请求参数**:

| 参数名称        | 说明    |    in |  是否必须      |  类型  |  schema  |

| ------------ | -------------------------------- |-----------|--------|----|--- |

|excel| excel  | formData | false |file  |    |

|headLineNum| headLineNum  | query | false |integer  |    |

|sheetNo| sheetNo  | query | false |integer  |    |

**响应数据**:

```json

```

**响应参数说明**:

暂无

**响应状态码说明**:

| 状态码        | 说明                            |    schema                        |

| ------------ | -------------------------------- |---------------------- |

| 200 | OK  ||

| 201 | Created  ||

| 401 | Unauthorized  ||

| 403 | Forbidden  ||

| 404 | Not Found  ||

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355

推荐阅读更多精彩内容