brand_pay_delivery.md 6.14 KB

Raw Blame History Permalink



品牌维度货到付款接口服务定义


查询品牌货到付款状态和品牌审核状态


根据品牌状态、品牌名称、货到付款状态查询品牌列表 OR 根据品牌状态、品牌名称、审核状态、货到付款状态查询品牌审核列表


接口名：/payDelivery/queryTotalBrandPayDelivery


入参

{
 "brandId":1,
 "brandName":"test",
 "isPayDelivery":1,
 "checkStatus":100,
 "page":1,
 "size":10
}


属性名称
类型
例子
说明


brandId
int
12
品牌ID(可选)


brandName
String
"test"
品牌名(可选)


isPayDelivery
int
1
是否支持货到付款(可选),0:不支持货到付款/1:支持


checkStatus
int
100
审核状态(可选,400: 全部 100：待审核 300：驳回,没有默认为400)


page
int
1
分页


size
int
10
页大小


返回

1.品牌列表(checkStatus=400或null)

{
  "code": 200,
  "data": {
    "list": [
      {
        "brandId": 1,
        "brandName": "004",
        "isPayDelivery": 1
      },
      {
        "brandId": 2,
        "brandName": "10x1",
        "isPayDelivery": 1
      }
    ],
    "page": 1,
    "size": 2,
    "total": 1461,
    "totalPage": 731
  },
  "message": "获取品牌列表成功"
}


2.品牌审核列表(checkStatus=100,300)

{
  "code": 200,
  "data": {
    "list": [
      {
        "applicant": "frw1111",
        "applicantPid": 11,
        "brandId": 12,
        "brandName": "test111",
        "checkStatus": 200,
        "createTime": 1460189176,
        "id": 1,
        "isPayDelivery": 1,
        "rejectReason": "12121212",
        "updateTime": 1460193604
      }
    ],
    "page": 1,
    "size": 2,
    "total": 1,
    "totalPage": 1
  },
  "message": "获取品牌审核列表成功"
}


查询审核个数、驳回个数、全部总数


接口名：/payDelivery/brandCount


入参

无


返回

{
  "code": 200,
  "data": {
    "checkIn": 3,
    "checkOk": 4,
    "checkNo": 5,
    "total": 10000
  },
  "md5": "5260752908ee4f536e4cedfb1aef8535",
  "message": "品牌请求成功."
}


## 打开关闭品牌货到付款

> 接口名：`/payDelivery/addPayDeliveryCheck`

### 入参
``` json
{
    "brandName":"test111",
    "brandId":12,
    "ispaydelivery":1
}


公共参数

{
    "x-user-id":12,
    "x-user-name":"frw"
}


属性名称
类型
例子
说明


brandId
int
12
品牌ID(必须)


brandName
String
"test"
品牌名(必须)


isPayDelivery
int
1
是否支持货到付款(必须,0:不支持货到付款/1:支持)


返回

{
  "code": 200,
  "data": {
    "applicant": "frw",
    "applicantPid": 12,
    "brandId": 12,
    "brandName": "test111",
    "checkStatus": 100,
    "isPayDelivery": 1,
    "rejectReason": ""
  },
  "md5": "5260752908ee4f536e4cedfb1aef8535",
  "message": "品牌请求成功."
}


操作品牌货到付款审核请求，驳回或者同意


接口名：/payDelivery/reviewPayDeliveryCheck


入参

{
    "id":1,
    "rejectReason":"12121212",
    "ispaydelivery":1,
    "checkstatus":300
}


公共参数

{
    "x-user-id":12,
    "x-user-name":"frw"
}


属性名称
类型
例子
说明


id
int
12
审核记录ID(必须)


brandId
int
12
品牌ID(必须)


rejectReason
String
"test"
拒绝原因(拒绝时需要)


isPayDelivery
int
1
是否支持货到付款(必选,0:不支持货到付款/1:支持)


checkStatus
int
100
审核状态(必选,200:通过/300：驳回)


返回

{
  "code": 200,
  "data": {
    "applicant": "frw1111",
    "applicantPid": 11,
    "auditor": "frw",
    "auditorPid": 12,
    "brandId": 12,
    "brandName": "test111",
    "checkStatus": 300,
    "id": 1,
    "isPayDelivery": 1,
    "rejectReason": ""
  },
  "md5": "f36580baa99719be692a43eea8d20c39",
  "message": "品牌审核成功."
}


导出品牌货到付款状态 xls


接口名：/batch/export


入参

{
    "type":"brandPayDeliveryExport",
     "queryConf":"{
     'brandId':12,
     'brandName':'test',
     'isPayDelivery':1
     }"
}


属性名称
类型
例子
说明


type
String
"brandPayDeliveryExport"
导出数据(必须)


queryConf
String
"{...}"
查询条件(必须)


brandId
int
12
品牌ID(可选)


brandName
String
"test"
品牌名(可选)


isPayDelivery
int
1
是否支持货到付款(可选,0:不支持货到付款/1:支持)


##导出品牌审核状态 xls

> 接口名：`/batch/export`

### 入参
``` json
{
    "type":"brandPayDeliveryCheckExport",
    "queryConf":"{
     'brandId':12,
     'brandName':'test',
     'isPayDelivery':1,
     'checkStatus':100
     }"
}


属性名称
类型
例子
说明


type
String
"brandPayDeliveryExport"
导出数据(必须)


queryConf
String
"{...}"
查询条件(必须)


brandId
int
12
品牌ID(可选)


brandName
String
"test"
品牌名(可选)


isPayDelivery
int
1
是否支持货到付款(可选,0:不支持货到付款/1:支持)


checkStatus
int
100
审核状态(可选 100:待审核/200:通过/300：驳回)


导出商品货到付款状态xls


接口名：/batch/export


入参

{
    "type":"productPayDeliveryExport",
    "queryConf":"{
     'brandId':12,
     'sknId':12,
     'isPayDelivery':1
     }"
}


属性名称
类型
例子
说明


type
String
"productPayDeliveryExport"
导出数据(必须)


queryConf
String
"{...}"
查询条件(必须)


brandId
int
12
品牌ID(可选)


isPayDelivery
int
1
是否支持货到付款(可选,0:不支持货到付款/1:支持)


sknId
int
100
skn(可选)