Blame view

inferface-document/brand.md 4.93 KB
xuhongyun authored
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
品牌管理接口服务定义
---------------------



## 品牌列表查询

> 接口名: 'brand/getBrandList'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|brandId|Number|43|品牌id|
|status|Number|0|状态|
|brandLevel|string|A|品牌级别|
|startTime|String|2016-01-12|开始时间|
|endTime|String|2016-01-13|结束时间|
|page|Number|2|第几页|
|size|Number|50|每页条数|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"请求成功",
    "data": {
        "list": [
            {
                "id": "",
                "brandIco": "",  //logo图片地址
                "brandNameCn": "",  //品牌中文名字
                "brandNameEn": "",   //品牌英文名字
                "brandLevel": "",       //级别
                "brandTonality": "",         //调性分
                "createTime": "",   //创建时间
                "status": 1   //1为开启状态,0为关闭状态
            }
        ],
        "offset": 0,
        "limit": 50,
        "total": 1000
    }
}

```


## 添加品牌接口

> 接口名: 'brand/addBrand'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|brandName|string|nike|品牌名称|
|brandNameEn|string|aaaa|英文名称|
|brandDomain|string|yoho|二级域名|
|brandIco|string|http://static.yohobuy.com/newheader/img/logo_e.png|品牌logo|
|brandLevel|string|KA|品牌级别|
|promotionLevel|int|2|品牌推广星级|
|mainCategory|int|2|主营类目|
|brandHeadstream|int|2|发源地|
|brandTypes|int|2|品牌类型|
liuyue authored
70
|saleType|int|2|合作模式|
xuhongyun authored
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
|brandUrl|string|www.baidu.com|品牌网址|
|brandIntro|string|xxxxxx|品牌介绍|
|brandOutline|string|xxxxxx|品牌简述|
|brandFounder|string|jay|品牌主理人|
|brandStyle|string|街头|品牌风格|
|brandNature|int|4|品牌性质|
|brandTonality|string|xxxx|调性指数|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"请求成功"
}

```


## 编辑/开启/关闭品牌接口

> 接口名: 'brand/editBrand'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|brandId|Number|43|品牌id|
liuyue authored
101
|status|String|0|关闭传0,开启传1|
xuhongyun authored
102 103 104 105 106 107 108 109 110
|brandName|string|nike|品牌名称|
|brandNameEn|string|aaaa|英文名称|
|brandDomain|string|yoho|二级域名|
|brandIco|string|http://static.yohobuy.com/newheader/img/logo_e.png|品牌logo|
|brandLevel|string|KA|品牌级别|
|promotionLevel|int|2|品牌推广星级|
|mainCategory|int|2|主营类目|
|brandHeadstream|int|2|发源地|
|brandTypes|int|2|品牌类型|
liuyue authored
111
|saleType|int|2|合作模式|
xuhongyun authored
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
|brandUrl|string|www.baidu.com|品牌网址|
|brandIntro|string|xxxxxx|品牌介绍|
|brandOutline|string|xxxxxx|品牌简述|
|brandFounder|string|jay|品牌主理人|
|brandStyle|string|街头|品牌风格|
|brandNature|int|4|品牌性质|
|brandTonality|string|xxxx|调性指数|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"请求成功"
}

```

## 编辑时品牌详情接口

> 接口名: 'brand/getBrandDetail'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|brandId|Number|43|品牌id|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"请求成功",
    "data": {
        "brandName": "",
        "brandNameEn": "",
        "brandDomain": "",
        "brandIco": "",
        "brandLevel": "",
        "promotionLevel": "",
        "mainCategory": "",
        "brandHeadstream": "",
        "brandTypes": "",
liuyue authored
159
        "saleType": "",
xuhongyun authored
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
        "brandUrl": "",
        "brandIntro": "",
        "brandOutline": "",
        "brandFounder": "",
        "brandStyle": "",
        "brandNature": "",
        "brandTonality": ""
    }
}

```


## 品牌获取选择选项的枚举接口

> 接口名: 'brand/getSelectItems'

### 返回

``` json
{
    "code":200,
    "message":"请求成功",
    "data": {
        "brandLevelItems": [{ //品牌级别
            "id": "",
            "name": ""
        }],
        "mainCategoryItems": [{  //主营类目
            "id": "",
            "name": ""
        }],
        "brandHeadstreamItems": [{   //发源地
            "id": "",
            "name": ""
        }],
        "brandTypesItems": [{    //品牌类型
            "id": "",
            "name": ""
        }],
        "brandStyleItems": [{    //品牌风格
            "id": "",
            "name": ""
        }],
        "brandNatureItems": [{   //品牌性质
            "id": "",
            "name": ""
        }],
    }
}

```


## 获取品牌列表接口

> 接口名: 'brand/getBrandName'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
liuyue authored
223
|idName|Number|43|品牌id或者名称|
xuhongyun authored
224 225 226 227 228 229 230 231
---------------------

### 返回

``` json
{
    "code":200,
    "message":"请求成功",
liuyue authored
232 233 234 235 236 237
    "data": [
        {
            "id": "",
            "name":""
        }
    ]
xuhongyun authored
238 239 240 241

}

```