jack / 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即为成功，否则是失败。 @@ -186,6 +186,7 @@ code为200即为成功，否则是失败。
186 |:-------| -----:|-----:|-----:|-----:|----:| 186 |:-------| -----:|-----:|-----:|-----:|----:|
187 |shop_id|int|否|346122|0|店铺id| 187 |shop_id|int|否|346122|0|店铺id|
188 188
  189 +
189 注意，通用的头部没有列出。 190 注意，通用的头部没有列出。
190 请求示例 191 请求示例
191 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 192 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即为成功，否则是失败。 @@ -214,6 +215,11 @@ code为200即为成功，否则是失败。
214 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 215 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
215 |:-------| -----:|-----:|-----:|-----:|----:| 216 |:-------| -----:|-----:|-----:|-----:|----:|
216 |shop_id|string|是|649|null|店铺id| 217 |shop_id|string|是|649|null|店铺id|
  218 +|limit|int|是|20|20|每页记录数|
  219 +|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
  220 +|page|int|是|1|1|当前页|
  221 +|yh_channel|int|是|1|1|频道：类型分为：男生、女生、潮童、创意生活|
  222 +|query|string|是|MACROPUS|无|搜索词|
217 223
218 注意，通用的头部没有列出，其他条件同原来保持一致。 224 注意，通用的头部没有列出，其他条件同原来保持一致。
219 请求示例 225 请求示例
@@ -764,10 +770,16 @@ code为200即为成功，否则是失败。 @@ -764,10 +770,16 @@ code为200即为成功，否则是失败。
764 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 770 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
765 |:-------| -----:|-----:|-----:|-----:|----:| 771 |:-------| -----:|-----:|-----:|-----:|----:|
766 |shop_id|string|是|649|null|店铺id| 772 |shop_id|string|是|649|null|店铺id|
  773 +|limit|int|是|20|20|每页记录数|
  774 +|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
  775 +|page|int|是|1|1|当前页|
  776 +|yh_channel|int|是|1|1|频道：类型分为：男生、女生、潮童、创意生活|
  777 +|query|string|是|MACROPUS|无|搜索词|
767 778
768 注意，通用的头部没有列出，其他条件同原来保持一致。 779 注意，通用的头部没有列出，其他条件同原来保持一致。
769 请求示例 780 请求示例
770 -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 781 +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=
  782 +&query=MACROPUS&debug=XYZ
771 ### 响应 783 ### 响应
772 code为200即为成功，否则是失败。 784 code为200即为成功，否则是失败。
773 响应JSON格式如下所示: 785 响应JSON格式如下所示:
@@ -1596,7 +1608,10 @@ code为200即为成功，否则是失败。 @@ -1596,7 +1608,10 @@ code为200即为成功，否则是失败。
1596 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 1608 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
1597 |:-------| -----:|-----:|-----:|-----:|----:| 1609 |:-------| -----:|-----:|-----:|-----:|----:|
1598 |id|int|否|323|0|店铺id| 1610 |id|int|否|323|0|店铺id|
  1611 +|fav_id|int|否|323|0|店铺id|
1599 |type|string|否|shop|0|收藏的类型，brand、product、shop| 1612 |type|string|否|shop|0|收藏的类型，brand、product、shop|
  1613 +|gender|string|是|1,3|无|性别|
  1614 +|uid|int|否|9963947|无|uid别|
1600 1615
1601 注意，通用的头部没有列出，同原来收藏品牌接口。 1616 注意，通用的头部没有列出，同原来收藏品牌接口。
1602 请求示例 1617 请求示例
@@ -1622,7 +1637,10 @@ code为200即为成功，否则是失败。 @@ -1622,7 +1637,10 @@ code为200即为成功，否则是失败。
1622 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 1637 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
1623 |:-------| -----:|-----:|-----:|-----:|----:| 1638 |:-------| -----:|-----:|-----:|-----:|----:|
1624 |id|int|否|323|0|店铺id| 1639 |id|int|否|323|0|店铺id|
  1640 +|fav_id|int|否|323|0|店铺id|
1625 |type|string|否|shop|0|收藏的类型，brand、product、shop| 1641 |type|string|否|shop|0|收藏的类型，brand、product、shop|
  1642 +|gender|string|是|1,3|无|性别|
  1643 +|uid|int|否|9963947|无|uid别|
1626 1644
1627 注意，通用的头部没有列出，同原来取消收藏品牌接口。 1645 注意，通用的头部没有列出，同原来取消收藏品牌接口。
1628 请求示例 1646 请求示例
@@ -1648,6 +1666,9 @@ code为200即为成功，否则是失败。 @@ -1648,6 +1666,9 @@ code为200即为成功，否则是失败。
1648 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 1666 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
1649 |:-------| -----:|-----:|-----:|-----:|----:| 1667 |:-------| -----:|-----:|-----:|-----:|----:|
1650 |uid|int|否|5772257|无|uid| 1668 |uid|int|否|5772257|无|uid|
  1669 +|gender|string|是|1,3|无|性别|
  1670 +|page|int|是|1|无|当前页|
  1671 +|limit|int|是|20|无|每页大小|
1651 1672
1652 注意，通用的头部没有列出，同原来查询收藏品牌列表接口。 1673 注意，通用的头部没有列出，同原来查询收藏品牌列表接口。
1653 请求示例 1674 请求示例
@@ -1658,7 +1679,7 @@ code为200即为成功，否则是失败。 @@ -1658,7 +1679,7 @@ code为200即为成功，否则是失败。
1658 ```json 1679 ```json
1659 1680
1660 ``` 1681 ```
1661 -## 11、商品详情页进入品牌店铺接口## 1682 +## 11、商品详情页进入品牌店铺接口，根据品牌id查询店铺列表##
1662 1683
1663 （method=app.shop.queryShopsByBrandId） 1684 （method=app.shop.queryShopsByBrandId）
1664 #### 请求参数 1685 #### 请求参数
@@ -1698,10 +1719,14 @@ code为200即为成功，否则是失败。 @@ -1698,10 +1719,14 @@ code为200即为成功，否则是失败。
1698 |subCategoryId|string|是|45|无|三级分类id| 1719 |subCategoryId|string|是|45|无|三级分类id|
1699 |sort|string|否|114,293|无|三级子分类id| 1720 |sort|string|否|114,293|无|三级子分类id|
1700 |shop_id|string|否|635|无|店铺id| 1721 |shop_id|string|否|635|无|店铺id|
  1722 +|limit|int|是|20|20|每页记录数|
  1723 +|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
  1724 +|page|int|是|1|1|当前页|
1701 1725
1702 注意，通用的头部没有列出，同原来分类商品列表接口。 1726 注意，通用的头部没有列出，同原来分类商品列表接口。
1703 请求示例 1727 请求示例
1704 -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 1728 +http://api.yoho.cn/?app_version=4.1.0&categoryId=5&client_secret=12f8bde3e01ee65c6961924eb55923ac&client_type=android&limit=20
  1729 +&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
1705 1730
1706 ### 响应 1731 ### 响应
1707 code为200即为成功，否则是失败。 1732 code为200即为成功，否则是失败。
@@ -2354,10 +2379,14 @@ code为200即为成功，否则是失败。 @@ -2354,10 +2379,14 @@ code为200即为成功，否则是失败。
2354 |categoryId|string|否|5|无|二级分类id| 2379 |categoryId|string|否|5|无|二级分类id|
2355 |subCategoryId|string|否|45|无|三级分类id| 2380 |subCategoryId|string|否|45|无|三级分类id|
2356 |sort|string|否|114,293|无|三级子分类id| 2381 |sort|string|否|114,293|无|三级子分类id|
  2382 +|limit|int|是|20|20|每页记录数|
  2383 +|order|string|否|s_t_desc|无|排序方式，具体参考app的请求报文|
  2384 +|page|int|是|1|1|当前页|
2357 2385
2358 注意，通用的头部没有列出，同原来分类商品列表接口。 2386 注意，通用的头部没有列出，同原来分类商品列表接口。
2359 请求示例 2387 请求示例
2360 -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 2388 +http://api.yoho.cn/?app_version=4.1.0&categoryId=5&client_secret=9b491dad7f82231c91eb09d181c297ef&client_type=android&limit=20&method=app.search.category
  2389 +&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
2361 2390
2362 ### 响应 2391 ### 响应
2363 code为200即为成功，否则是失败。 2392 code为200即为成功，否则是失败。