Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by iknitting
Commit 017773a6826009055b8881a7a3b2cbee39d00892 1 parent 53f7cd29

修改接口文档

Inline Side-by-side
Showing 1 changed file with 33 additions and 4 deletions
... ... @@ -186,6 +186,7 @@ code为200即为成功，否则是失败。
|:-------| -----:|-----:|-----:|-----:|----:|
|shop_id|int|否|346122|0|店铺id|
注意，通用的头部没有列出。
请求示例
http://devapi.yoho.cn:58078/?app_version=4.0.0&debug=XYZ&client_secret=e1520774fd4f8f228584ff80c99b809c&client_type=android&method=app.shops.getShopsBrands&shop_id=323&os_version=android4.4.2%3AMX4&screen_size=1152x1920&v=7
... ... @@ -214,6 +215,11 @@ code为200即为成功，否则是失败。
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|shop_id|string|是|649|null|店铺id|
|limit|int|是|20|20|每页记录数|
|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
|page|int|是|1|1|当前页|
|yh_channel|int|是|1|1|频道：类型分为：男生、女生、潮童、创意生活|
|query|string|是|MACROPUS|无|搜索词|
注意，通用的头部没有列出，其他条件同原来保持一致。
请求示例
... ... @@ -764,10 +770,16 @@ code为200即为成功，否则是失败。
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|shop_id|string|是|649|null|店铺id|
|limit|int|是|20|20|每页记录数|
|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
|page|int|是|1|1|当前页|
|yh_channel|int|是|1|1|频道：类型分为：男生、女生、潮童、创意生活|
|query|string|是|MACROPUS|无|搜索词|
注意，通用的头部没有列出，其他条件同原来保持一致。
请求示例
http://devapi.yoho.cn:58078/gateway/?limit=20&method=app.search.li&order=s_n_desc&page=1&productSize=240x319&shop_id=649&v=7&yh_channel=&query=MACROPUS&debug=XYZ
http://devapi.yoho.cn:58078/gateway/?limit=20&method=app.search.li&order=s_n_desc&page=1&productSize=240x319&shop_id=649&v=7&yh_channel=
&query=MACROPUS&debug=XYZ
### 响应
code为200即为成功，否则是失败。
响应JSON格式如下所示:
... ... @@ -1596,7 +1608,10 @@ code为200即为成功，否则是失败。
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|id|int|否|323|0|店铺id|
|fav_id|int|否|323|0|店铺id|
|type|string|否|shop|0|收藏的类型，brand、product、shop|
|gender|string|是|1,3|无|性别|
|uid|int|否|9963947|无|uid别|
注意，通用的头部没有列出，同原来收藏品牌接口。
请求示例
... ... @@ -1622,7 +1637,10 @@ code为200即为成功，否则是失败。
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|id|int|否|323|0|店铺id|
|fav_id|int|否|323|0|店铺id|
|type|string|否|shop|0|收藏的类型，brand、product、shop|
|gender|string|是|1,3|无|性别|
|uid|int|否|9963947|无|uid别|
注意，通用的头部没有列出，同原来取消收藏品牌接口。
请求示例
... ... @@ -1648,6 +1666,9 @@ code为200即为成功，否则是失败。
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|5772257|无|uid|
|gender|string|是|1,3|无|性别|
|page|int|是|1|无|当前页|
|limit|int|是|20|无|每页大小|
注意，通用的头部没有列出，同原来查询收藏品牌列表接口。
请求示例
... ... @@ -1658,7 +1679,7 @@ code为200即为成功，否则是失败。
```json
```
## 11、商品详情页进入品牌店铺接口##
## 11、商品详情页进入品牌店铺接口，根据品牌id查询店铺列表##
（method=app.shop.queryShopsByBrandId）
#### 请求参数
... ... @@ -1698,10 +1719,14 @@ code为200即为成功，否则是失败。
|subCategoryId|string|是|45|无|三级分类id|
|sort|string|否|114,293|无|三级子分类id|
|shop_id|string|否|635|无|店铺id|
|limit|int|是|20|20|每页记录数|
|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
|page|int|是|1|1|当前页|
注意，通用的头部没有列出，同原来分类商品列表接口。
请求示例
http://api.yoho.cn/?app_version=4.1.0&categoryId=5&client_secret=12f8bde3e01ee65c6961924eb55923ac&client_type=android&limit=20&method=app.search.category&order=s_t_desc&os_version=android4.4.4%3AChe1-CL20&page=1&productSize=240x319&screen_size=720x1280&sort=114%2C293%2C116%2C117%2C115%2C119%2C124%2C122%2C413%2C258%2C173%2C227%2C125%2C118%2C121%2C123&subCategoryId=&v=7&yh_channel=1
http://api.yoho.cn/?app_version=4.1.0&categoryId=5&client_secret=12f8bde3e01ee65c6961924eb55923ac&client_type=android&limit=20
&method=app.search.category&order=s_t_desc&os_version=android4.4.4%3AChe1-CL20&page=1&productSize=240x319&screen_size=720x1280&sort=114%2C293%2C116%2C117%2C115%2C119%2C124%2C122%2C413%2C258%2C173%2C227%2C125%2C118%2C121%2C123&subCategoryId=&v=7&yh_channel=1
### 响应
code为200即为成功，否则是失败。
... ... @@ -2354,10 +2379,14 @@ code为200即为成功，否则是失败。
|categoryId|string|否|5|无|二级分类id|
|subCategoryId|string|否|45|无|三级分类id|
|sort|string|否|114,293|无|三级子分类id|
|limit|int|是|20|20|每页记录数|
|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
|page|int|是|1|1|当前页|
注意，通用的头部没有列出，同原来分类商品列表接口。
请求示例
http://api.yoho.cn/?app_version=4.1.0&categoryId=5&client_secret=9b491dad7f82231c91eb09d181c297ef&client_type=android&limit=20&method=app.search.category&order=s_t_desc&os_version=android4.4.4%3AChe1-CL20&page=1&productSize=240x319&screen_size=720x1280&sort=114%2C293&subCategoryId=45&v=7&yh_channel=1
http://api.yoho.cn/?app_version=4.1.0&categoryId=5&client_secret=9b491dad7f82231c91eb09d181c297ef&client_type=android&limit=20&method=app.search.category
&order=s_t_desc&os_version=android4.4.4%3AChe1-CL20&page=1&productSize=240x319&screen_size=720x1280&sort=114%2C293&subCategoryId=45&v=7&yh_channel=1
### 响应
code为200即为成功，否则是失败。
... ...