**京東返現(xiàn)**
**簡(jiǎn)介**:京東返現(xiàn)
**HOST**:localhost:8888
**聯(lián)系人**:京東
**Version**:1.0
**接口路徑**:/v2/api-docs?group=2.X版本
# 掌柜管家需求接口
## settlement
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/addCashbackSettlement`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"activeId": 0,
"createBy": 0,
"createTime": "",
"delFlag": 0,
"id": 0,
"orderId": "",
"settlementAmount": 0,
"settlementTime": "",
"transactionConfirmed": 0,
"transactionId": 0,
"updateBy": 0,
"updateTime": ""
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|req| req? | body | true |CashbackSettlement? | CashbackSettlement? |
**schema屬性說(shuō)明**
**CashbackSettlement**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| 活動(dòng)id? | body | false |integer(int64)? |? ? |
|createBy| 創(chuàng)建人? | body | false |integer(int64)? |? ? |
|createTime| 創(chuàng)建時(shí)間? | body | false |string(date-time)? |? ? |
|delFlag| 刪除標(biāo)記? | body | false |integer(int32)? |? ? |
|id| 主鍵id? | body | false |integer(int64)? |? ? |
|orderId| 數(shù)組型的訂單id? | body | false |string? |? ? |
|settlementAmount| 結(jié)算金額? | body | false |number? |? ? |
|settlementTime| 結(jié)算時(shí)間? | body | false |string(date-time)? |? ? |
|transactionConfirmed| 轉(zhuǎn)賬狀態(tài)(0:new settlement,1: transaction confirmed)? | body | false |integer(int32)? |? ? |
|transactionId| 轉(zhuǎn)賬卡號(hào)? | body | false |integer(int64)? |? ? |
|updateBy| 更新人? | body | false |integer(int64)? |? ? |
|updateTime| 更新時(shí)間? | body | false |string(date-time)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 確認(rèn)轉(zhuǎn)賬
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/addCashbackTransferConfirmation`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"createBy": 0,
"createTime": "",
"delFlag": 0,
"id": 0,
"payerName": "",
"serialNumberBank": "",
"settlementId": 0,
"settlementTime": "",
"updateBy": 0,
"updateTime": ""
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|cashbackTransferConfirmation| cashbackTransferConfirmation? | body | true |CashbackTransferConfirmation? | CashbackTransferConfirmation? |
**schema屬性說(shuō)明**
**CashbackTransferConfirmation**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|createBy| 創(chuàng)建人? | body | false |integer(int64)? |? ? |
|createTime| 創(chuàng)建時(shí)間? | body | false |string(date-time)? |? ? |
|delFlag| 刪除標(biāo)記? | body | false |integer(int32)? |? ? |
|id| 主鍵id? | body | false |integer(int64)? |? ? |
|payerName| 轉(zhuǎn)款人姓名? | body | false |string? |? ? |
|serialNumberBank| 流水賬號(hào)? | body | false |string? |? ? |
|settlementId| 結(jié)算ID? | body | false |integer(int64)? |? ? |
|settlementTime| 轉(zhuǎn)賬時(shí)間? | body | false |string(date-time)? |? ? |
|updateBy| 更新人? | body | false |integer(int64)? |? ? |
|updateTime| 更新時(shí)間? | body | false |string(date-time)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## all order size/所有訂單tab頁(yè)總條數(shù)
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/cashBackAllOrderSize/{activeId}`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| activeId? | path | true |integer? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## cash back主頁(yè)面>右側(cè):活動(dòng)詳情/活動(dòng)進(jìn)度
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/joinActive`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| 活動(dòng)id? | query | true |string? |? ? |
|shopId| 店鋪id? | query | true |string? |? ? |
|shopName| 店鋪名稱? | query | true |string? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
{
"activeTime": "",
"cashbackState": 0,
"createErp": "",
"endTime": "",
"id": 0,
"name": "",
"startTime": ""
}
```
**響應(yīng)參數(shù)說(shuō)明**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? 類(lèi)型 |? schema |
| ------------ | -------------------|-------|----------- |
|activeTime| 活動(dòng)時(shí)間? |string? |? ? |
|cashbackState| 活動(dòng)狀態(tài)? |integer(int32)? | integer(int32)? |
|createErp| 創(chuàng)建人erp? |string? |? ? |
|endTime|? |string? |? ? |
|id| 活動(dòng)id? |integer(int64)? | integer(int64)? |
|name| 活動(dòng)名稱? |string? |? ? |
|startTime|? |string? |? ? |
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? |活動(dòng)狀態(tài)查詢列表|
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## view the orders of settlement
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashBackSettlementById/{id}`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|id| id? | path | true |integer? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## view the orders of settlement 1/分頁(yè)按鈕
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashBackSettlementByPage`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"id": 0,
"pageNum": 0,
"pageSize": 0
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|req| req? | body | true |SettlementOrderPageReq? | SettlementOrderPageReq? |
**schema屬性說(shuō)明**
**SettlementOrderPageReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|id|? | body | false |integer(int64)? |? ? |
|pageNum| 當(dāng)前頁(yè)? | body | false |integer(int32)? |? ? |
|pageSize| 每頁(yè)顯示幾條? | body | false |integer(int32)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## waiting for settlement/待結(jié)算
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPage`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"activeId": 0,
"endTime": "",
"orderType": 0,
"pageNum": 0,
"pageSize": 0,
"startTime": ""
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|req| req? | body | true |OrderStatusReq? | OrderStatusReq? |
**schema屬性說(shuō)明**
**OrderStatusReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| 活動(dòng)id? | body | false |integer(int64)? |? ? |
|endTime| 訂單結(jié)束時(shí)間? | body | false |string(date-time)? |? ? |
|orderType| 訂單類(lèi)型? | body | false |integer(int32)? |? ? |
|pageNum| 當(dāng)前頁(yè)? | body | false |integer(int32)? |? ? |
|pageSize| 每頁(yè)顯示幾條? | body | false |integer(int32)? |? ? |
|startTime| 訂單開(kāi)始時(shí)間? | body | false |string(date-time)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## all order/所有訂單
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPageAllOrder`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"activeId": 0,
"endTime": "",
"orderType": 0,
"pageNum": 0,
"pageSize": 0,
"startTime": ""
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|req| req? | body | true |OrderStatusReq? | OrderStatusReq? |
**schema屬性說(shuō)明**
**OrderStatusReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| 活動(dòng)id? | body | false |integer(int64)? |? ? |
|endTime| 訂單結(jié)束時(shí)間? | body | false |string(date-time)? |? ? |
|orderType| 訂單類(lèi)型? | body | false |integer(int32)? |? ? |
|pageNum| 當(dāng)前頁(yè)? | body | false |integer(int32)? |? ? |
|pageSize| 每頁(yè)顯示幾條? | body | false |integer(int32)? |? ? |
|startTime| 訂單開(kāi)始時(shí)間? | body | false |string(date-time)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 已轉(zhuǎn)賬的訂單
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPageTransfer`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"activeId": 0,
"endTime": "",
"orderType": 0,
"pageNum": 0,
"pageSize": 0,
"startTime": ""
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|req| req? | body | true |OrderStatusReq? | OrderStatusReq? |
**schema屬性說(shuō)明**
**OrderStatusReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| 活動(dòng)id? | body | false |integer(int64)? |? ? |
|endTime| 訂單結(jié)束時(shí)間? | body | false |string(date-time)? |? ? |
|orderType| 訂單類(lèi)型? | body | false |integer(int32)? |? ? |
|pageNum| 當(dāng)前頁(yè)? | body | false |integer(int32)? |? ? |
|pageSize| 每頁(yè)顯示幾條? | body | false |integer(int32)? |? ? |
|startTime| 訂單開(kāi)始時(shí)間? | body | false |string(date-time)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 已轉(zhuǎn)賬的訂單總條數(shù)
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashOrderPageTransferSize/{activeId}`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| activeId? | path | true |integer? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## cash back主頁(yè)面>右側(cè):活動(dòng)詳情/活動(dòng)進(jìn)度
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashbackActiveDetail`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| 活動(dòng)id? | query | true |string? |? ? |
|activeState| 活動(dòng)狀態(tài)(2未開(kāi)始,3已發(fā)布,4進(jìn)行中,5已結(jié)束))? | query | true |string? |? ? |
|joinState| 是否參加活動(dòng)(1:參加,2未參加)? | query | true |string? |? ? |
|shopId| 店鋪id? | query | true |string? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
{
"activeTime": "",
"cashbackState": 0,
"createErp": "",
"endTime": "",
"id": 0,
"name": "",
"startTime": ""
}
```
**響應(yīng)參數(shù)說(shuō)明**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? 類(lèi)型 |? schema |
| ------------ | -------------------|-------|----------- |
|activeTime| 活動(dòng)時(shí)間? |string? |? ? |
|cashbackState| 活動(dòng)狀態(tài)? |integer(int32)? | integer(int32)? |
|createErp| 創(chuàng)建人erp? |string? |? ? |
|endTime|? |string? |? ? |
|id| 活動(dòng)id? |integer(int64)? | integer(int64)? |
|name| 活動(dòng)名稱? |string? |? ? |
|startTime|? |string? |? ? |
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? |活動(dòng)狀態(tài)查詢列表|
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## cash back主頁(yè)面>左側(cè):活動(dòng)列表
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashbackActiveList`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeState| 0:onGonging,1:history? | query | true |string? |? ? |
|shopId| 店鋪id? | query | true |string? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
{
"activeId": 0,
"activeTime": "",
"cashbackRule": "",
"cashbackState": 0,
"endTime": "",
"joinState": 0,
"name": "",
"newUserCount": 0,
"point": "",
"progress": "",
"progressAmount": 0,
"startTime": ""
}
```
**響應(yīng)參數(shù)說(shuō)明**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? 類(lèi)型 |? schema |
| ------------ | -------------------|-------|----------- |
|activeId| 活動(dòng)id? |integer(int64)? | integer(int64)? |
|activeTime| 活動(dòng)時(shí)間? |string? |? ? |
|cashbackRule| 活動(dòng)規(guī)則(0:order cashback,1:new user cashback,order cashback & 2:new user cashback)? |string? |? ? |
|cashbackState| 活動(dòng)狀態(tài)(1未發(fā)布,2未開(kāi)始,3已發(fā)布,4進(jìn)行中,5已結(jié)束)? |integer(int32)? | integer(int32)? |
|endTime| 活動(dòng)結(jié)束時(shí)間? |string(date-time)? | string(date-time)? |
|joinState| 參加標(biāo)識(shí)(1:參加,2未參加)? |integer(int32)? | integer(int32)? |
|name| 活動(dòng)名稱? |string? |? ? |
|newUserCount| 用戶返現(xiàn):顯示已有用戶數(shù)量(進(jìn)行中,且參加了活動(dòng)才有此信息)? |integer(int32)? | integer(int32)? |
|point| 活動(dòng)亮點(diǎn)? |string? |? ? |
|progress| 訂單返現(xiàn):展示進(jìn)度條(進(jìn)行中,且參加了活動(dòng)才有此信息)? |string? |? ? |
|progressAmount| 當(dāng)前完成總金額? |number? |? ? |
|startTime| 活動(dòng)開(kāi)始時(shí)間? |string(date-time)? | string(date-time)? |
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? |ActiveListResponse|
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## all order and waiting for settlement/待結(jié)算頁(yè)面列表
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/shopkeeper/queryCashbackSettlementByPage`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"activeId": 0,
"endTime": "",
"orderType": 0,
"pageNum": 0,
"pageSize": 0,
"startTime": ""
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|req| req? | body | true |OrderStatusReq? | OrderStatusReq? |
**schema屬性說(shuō)明**
**OrderStatusReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| 活動(dòng)id? | body | false |integer(int64)? |? ? |
|endTime| 訂單結(jié)束時(shí)間? | body | false |string(date-time)? |? ? |
|orderType| 訂單類(lèi)型? | body | false |integer(int32)? |? ? |
|pageNum| 當(dāng)前頁(yè)? | body | false |integer(int32)? |? ? |
|pageSize| 每頁(yè)顯示幾條? | body | false |integer(int32)? |? ? |
|startTime| 訂單開(kāi)始時(shí)間? | body | false |string(date-time)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
# 活動(dòng)設(shè)置
## 新增活動(dòng)設(shè)置
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/addCashbackActive`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```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
}
]
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeReq| activeReq? | body | true |ActiveReq? | ActiveReq? |
**schema屬性說(shuō)明**
**ActiveReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|cashbackActive|? | body | false |CashbackActive? | CashbackActive? |
|cashbackActiveRuleList|? | body | false |array? | 返現(xiàn)活動(dòng)規(guī)則詳情? |
**CashbackActive**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|area| 門(mén)店范圍:必選,單選;分為全部門(mén)店和部分門(mén)店(選擇部分門(mén)店后,該活動(dòng)只能被選中門(mén)店查看。選擇部門(mén)門(mén)店時(shí),需要用戶上傳excel文件,確定活動(dòng)包含的門(mén)店范圍)? | body | false |string? |? ? |
|cashbackRule| 0:訂單返現(xiàn)1:用戶返現(xiàn),2:訂單&用戶? | body | false |integer(int32)? |? ? |
|cashbackState| 活動(dòng)狀態(tài)(1未發(fā)布,2未開(kāi)始,3已發(fā)布,4進(jìn)行中,5已結(jié)束)? | body | false |integer(int32)? |? ? |
|consumerType| 用戶類(lèi)型: 必選,多選;分為門(mén)店會(huì)員和非門(mén)店會(huì)員? | body | false |integer(int64)? |? ? |
|createBy| 創(chuàng)建人? | body | false |integer(int64)? |? ? |
|createTime| 創(chuàng)建時(shí)間? | body | false |string(date-time)? |? ? |
|delFlag| 刪除標(biāo)記? | body | false |integer(int32)? |? ? |
|endTime| 結(jié)束時(shí)間:必填,開(kāi)始時(shí)間:默認(rèn)當(dāng)前時(shí)間,精確至?xí)r分秒,活動(dòng)不可以早于當(dāng)前時(shí)間;結(jié)束時(shí)間:默認(rèn)時(shí)分秒為23:59:59,與開(kāi)始時(shí)間最大間隔為90天? | body | false |string(date-time)? |? ? |
|id| 主鍵id? | body | false |integer(int64)? |? ? |
|name| 活動(dòng)名稱:必填,不為空,語(yǔ)言特殊字符等無(wú)需校驗(yàn),最多200個(gè)字符? | body | false |string? |? ? |
|orderType|? 訂單類(lèi)型:必選,單選;分為線下門(mén)店訂單和線上JD Central訂單? | body | false |integer(int64)? |? ? |
|payType| 支付類(lèi)型:必選,多選;分為現(xiàn)金,POS,其他? | body | false |integer(int64)? |? ? |
|point| 活動(dòng)亮點(diǎn):非必填,語(yǔ)言特殊字符等無(wú)需校驗(yàn),最多100個(gè)字符? | body | false |string? |? ? |
|startTime| 開(kāi)始時(shí)間:必填,開(kāi)始時(shí)間:默認(rèn)當(dāng)前時(shí)間,精確至?xí)r分秒,活動(dòng)不可以早于當(dāng)前時(shí)間;結(jié)束時(shí)間:默認(rèn)時(shí)分秒為23:59:59,與開(kāi)始時(shí)間最大間隔為90天? | body | false |string(date-time)? |? ? |
|timeType| 時(shí)間口徑:必選,單選;分為下單時(shí)間和完成時(shí)間;下單時(shí)間:訂單在JDC側(cè)的生成時(shí)間完成時(shí)間:訂單在JDC側(cè)的完成時(shí)間(COD訂單需要在財(cái)務(wù)對(duì)賬之后完成)? | body | false |integer(int64)? |? ? |
|updateBy| 更新人? | body | false |integer(int64)? |? ? |
|updateTime| 更新時(shí)間? | body | false |string(date-time)? |? ? |
**返現(xiàn)活動(dòng)規(guī)則詳情**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|cashbackActiveId| 返現(xiàn)活動(dòng)id? | body | false |integer(int64)? |? ? |
|cashbackAmount| 返現(xiàn)金額/比例? | body | false |number? |? ? |
|cashbackCeiling| 返現(xiàn)上限? | body | false |number? |? ? |
|cashbackCompany| 泰銖/%? | body | false |string? |? ? |
|consumerNumber| 新用戶數(shù)? | body | false |integer(int64)? |? ? |
|endAmount| 結(jié)束金額? | body | false |number? |? ? |
|id| 主鍵id? | body | false |integer(int64)? |? ? |
|ruleStep| 規(guī)則階梯(1:一階梯,2:二階梯,3三階梯,4:用戶返現(xiàn))? | body | false |integer(int64)? |? ? |
|startAmount| 起始金額? | body | false |number? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 返現(xiàn)活動(dòng)查詢 > 活動(dòng)數(shù)據(jù)查詢 > 查看詳情
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/cashbackActiveDetail/{id}`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|id| 活動(dòng)id? | query | true |string? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
{
"activeId": 0,
"conformPart": 0,
"expectedAmount": 0,
"expectedReturn": 0,
"joinTime": "",
"storeId": 0,
"storeName": ""
}
```
**響應(yīng)參數(shù)說(shuō)明**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? 類(lèi)型 |? schema |
| ------------ | -------------------|-------|----------- |
|activeId| 活動(dòng)id? |integer(int64)? | integer(int64)? |
|conformPart| 符合參與? |number? |? ? |
|expectedAmount| 當(dāng)前進(jìn)度? |number? |? ? |
|expectedReturn| 預(yù)計(jì)返現(xiàn)金額? |number? |? ? |
|joinTime| 報(bào)名時(shí)間? |string(date-time)? | string(date-time)? |
|storeId| 店鋪id? |integer(int64)? | integer(int64)? |
|storeName| 店鋪名稱? |string? |? ? |
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? |ActiveStoreResponse|
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 活動(dòng)發(fā)布
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/cashbackActivePublish/{id}`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|id| 活動(dòng)id? | query | true |string? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 活動(dòng)刪除
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/cashbackActiveRemove/{id}`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|id| 活動(dòng)id? | query | true |string? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 返現(xiàn)活動(dòng)查詢 > 活動(dòng)數(shù)據(jù)查詢 > 查看詳情--查看訂單
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/cashbackOrderList`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| activeId? | query | false |integer? |? ? |
|storeId| storeId? | query | false |integer? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 校驗(yàn)與活動(dòng)疊加時(shí)段是否有同訂單類(lèi)型的活動(dòng)已經(jīng)創(chuàng)建
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/checkCashbackActive`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```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
}
]
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeReq| activeReq? | body | true |ActiveReq? | ActiveReq? |
**schema屬性說(shuō)明**
**ActiveReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|cashbackActive|? | body | false |CashbackActive? | CashbackActive? |
|cashbackActiveRuleList|? | body | false |array? | 返現(xiàn)活動(dòng)規(guī)則詳情? |
**CashbackActive**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|area| 門(mén)店范圍:必選,單選;分為全部門(mén)店和部分門(mén)店(選擇部分門(mén)店后,該活動(dòng)只能被選中門(mén)店查看。選擇部門(mén)門(mén)店時(shí),需要用戶上傳excel文件,確定活動(dòng)包含的門(mén)店范圍)? | body | false |string? |? ? |
|cashbackRule| 0:訂單返現(xiàn)1:用戶返現(xiàn),2:訂單&用戶? | body | false |integer(int32)? |? ? |
|cashbackState| 活動(dòng)狀態(tài)(1未發(fā)布,2未開(kāi)始,3已發(fā)布,4進(jìn)行中,5已結(jié)束)? | body | false |integer(int32)? |? ? |
|consumerType| 用戶類(lèi)型: 必選,多選;分為門(mén)店會(huì)員和非門(mén)店會(huì)員? | body | false |integer(int64)? |? ? |
|createBy| 創(chuàng)建人? | body | false |integer(int64)? |? ? |
|createTime| 創(chuàng)建時(shí)間? | body | false |string(date-time)? |? ? |
|delFlag| 刪除標(biāo)記? | body | false |integer(int32)? |? ? |
|endTime| 結(jié)束時(shí)間:必填,開(kāi)始時(shí)間:默認(rèn)當(dāng)前時(shí)間,精確至?xí)r分秒,活動(dòng)不可以早于當(dāng)前時(shí)間;結(jié)束時(shí)間:默認(rèn)時(shí)分秒為23:59:59,與開(kāi)始時(shí)間最大間隔為90天? | body | false |string(date-time)? |? ? |
|id| 主鍵id? | body | false |integer(int64)? |? ? |
|name| 活動(dòng)名稱:必填,不為空,語(yǔ)言特殊字符等無(wú)需校驗(yàn),最多200個(gè)字符? | body | false |string? |? ? |
|orderType|? 訂單類(lèi)型:必選,單選;分為線下門(mén)店訂單和線上JD Central訂單? | body | false |integer(int64)? |? ? |
|payType| 支付類(lèi)型:必選,多選;分為現(xiàn)金,POS,其他? | body | false |integer(int64)? |? ? |
|point| 活動(dòng)亮點(diǎn):非必填,語(yǔ)言特殊字符等無(wú)需校驗(yàn),最多100個(gè)字符? | body | false |string? |? ? |
|startTime| 開(kāi)始時(shí)間:必填,開(kāi)始時(shí)間:默認(rèn)當(dāng)前時(shí)間,精確至?xí)r分秒,活動(dòng)不可以早于當(dāng)前時(shí)間;結(jié)束時(shí)間:默認(rèn)時(shí)分秒為23:59:59,與開(kāi)始時(shí)間最大間隔為90天? | body | false |string(date-time)? |? ? |
|timeType| 時(shí)間口徑:必選,單選;分為下單時(shí)間和完成時(shí)間;下單時(shí)間:訂單在JDC側(cè)的生成時(shí)間完成時(shí)間:訂單在JDC側(cè)的完成時(shí)間(COD訂單需要在財(cái)務(wù)對(duì)賬之后完成)? | body | false |integer(int64)? |? ? |
|updateBy| 更新人? | body | false |integer(int64)? |? ? |
|updateTime| 更新時(shí)間? | body | false |string(date-time)? |? ? |
**返現(xiàn)活動(dòng)規(guī)則詳情**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|cashbackActiveId| 返現(xiàn)活動(dòng)id? | body | false |integer(int64)? |? ? |
|cashbackAmount| 返現(xiàn)金額/比例? | body | false |number? |? ? |
|cashbackCeiling| 返現(xiàn)上限? | body | false |number? |? ? |
|cashbackCompany| 泰銖/%? | body | false |string? |? ? |
|consumerNumber| 新用戶數(shù)? | body | false |integer(int64)? |? ? |
|endAmount| 結(jié)束金額? | body | false |number? |? ? |
|id| 主鍵id? | body | false |integer(int64)? |? ? |
|ruleStep| 規(guī)則階梯(1:一階梯,2:二階梯,3三階梯,4:用戶返現(xiàn))? | body | false |integer(int64)? |? ? |
|startAmount| 起始金額? | body | false |number? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 導(dǎo)出部分門(mén)店的活動(dòng)id
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/exportExcel`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId| activeId? | query | false |integer? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 活動(dòng)數(shù)據(jù)查詢?cè)斍?/p>
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/queryCashbackActive/{id}`
**請(qǐng)求方式**:`GET`
**consumes**:``
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|id| id? | path | true |integer? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 活動(dòng)列表分頁(yè)查詢
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/queryCashbackActiveByPage`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"activeBeginTime": "",
"activeEndTime": "",
"cashbackState": 0,
"createErp": "",
"id": 0,
"pageNum": 0,
"pageSize": 0
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|cashbackActiveListQuery| cashbackActiveListQuery? | body | true |活動(dòng)狀態(tài)查詢頁(yè)面查詢條件? | 活動(dòng)狀態(tài)查詢頁(yè)面查詢條件? |
**schema屬性說(shuō)明**
**活動(dòng)狀態(tài)查詢頁(yè)面查詢條件**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeBeginTime| 活動(dòng)開(kāi)始時(shí)間? | body | false |string? |? ? |
|activeEndTime| 活動(dòng)結(jié)束時(shí)間? | body | false |string? |? ? |
|cashbackState| 活動(dòng)狀態(tài)(未發(fā)布,未開(kāi)始,已發(fā)布,進(jìn)行中,已結(jié)束)? | body | false |integer(int32)? |? ? |
|createErp| 活動(dòng)創(chuàng)建erp? | body | false |string? |? ? |
|id| 活動(dòng)id? | body | false |integer(int64)? |? ? |
|pageNum| 當(dāng)前頁(yè)? | body | false |integer(int32)? |? ? |
|pageSize| 每頁(yè)顯示幾條? | body | false |integer(int32)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
{
"activeTime": "",
"cashbackState": 0,
"createErp": "",
"endTime": "",
"id": 0,
"name": "",
"startTime": ""
}
```
**響應(yīng)參數(shù)說(shuō)明**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? 類(lèi)型 |? schema |
| ------------ | -------------------|-------|----------- |
|activeTime| 活動(dòng)時(shí)間? |string? |? ? |
|cashbackState| 活動(dòng)狀態(tài)? |integer(int32)? | integer(int32)? |
|createErp| 創(chuàng)建人erp? |string? |? ? |
|endTime|? |string? |? ? |
|id| 活動(dòng)id? |integer(int64)? | integer(int64)? |
|name| 活動(dòng)名稱? |string? |? ? |
|startTime|? |string? |? ? |
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? |活動(dòng)狀態(tài)查詢列表|
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 活動(dòng)數(shù)據(jù)查詢頁(yè)面
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/queryCashbackActiveDataPage`
**請(qǐng)求方式**:`POST`
**consumes**:`["application/json"]`
**produces**:`["*/*"]`
**請(qǐng)求示例**:
```json
{
"activeId": 0,
"createErp": 0,
"pageNum": 0,
"pageSize": 0,
"status": 0
}
```
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeDataReq| activeDataReq? | body | true |CashbackActiveDataReq? | CashbackActiveDataReq? |
**schema屬性說(shuō)明**
**CashbackActiveDataReq**
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? |? 類(lèi)型? |? schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|activeId|? | body | false |integer(int64)? |? ? |
|createErp|? | body | false |integer(int64)? |? ? |
|pageNum| 當(dāng)前頁(yè)? | body | false |integer(int32)? |? ? |
|pageSize| 每頁(yè)顯示幾條? | body | false |integer(int32)? |? ? |
|status|? | body | false |integer(int32)? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||
## 讀取 Excel(指定某個(gè) sheet)
**接口說(shuō)明**:
**接口地址**:`/cashback/storesaas/cashback/active/uploadExcel`
**請(qǐng)求方式**:`POST`
**consumes**:`["multipart/form-data"]`
**produces**:`["*/*"]`
**請(qǐng)求參數(shù)**:
| 參數(shù)名稱? ? ? ? | 說(shuō)明? ? |? ? in |? 是否必須? ? ? |? 類(lèi)型? |? schema? |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|excel| excel? | formData | false |file? |? ? |
|headLineNum| headLineNum? | query | false |integer? |? ? |
|sheetNo| sheetNo? | query | false |integer? |? ? |
**響應(yīng)數(shù)據(jù)**:
```json
```
**響應(yīng)參數(shù)說(shuō)明**:
暫無(wú)
**響應(yīng)狀態(tài)碼說(shuō)明**:
| 狀態(tài)碼? ? ? ? | 說(shuō)明? ? ? ? ? ? ? ? ? ? ? ? ? ? |? ? schema? ? ? ? ? ? ? ? ? ? ? ? |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK? ||
| 201 | Created? ||
| 401 | Unauthorized? ||
| 403 | Forbidden? ||
| 404 | Not Found? ||