huangping / API-Interfaces · Commits

Go to a project

Authored by chenjian
Commit eed5a97fe6722f2a3b0167e3f7e5c4aef18862bf 2 parents 30e631f6 e078bedf

Merge branch 'master' of http://git.dev.yoho.cn/yoho-documents/api-interfaces

Inline Side-by-side
Showing 6 changed files with 867 additions and 153 deletions
  1 +## 1、订阅降价通知接口##
  2 +
  3 +订阅降价通知接口（method=web.redution.add）
  4 +#### 请求参数
  5 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|----:|
  7 +|uid|int|否|213|0|用户id|
  8 +|mobile|string|否|13211111111|0|手机号码|
  9 +|productId|int|否|214217|0|商品id|
  10 +
  11 +注意，通用的头部没有列出。
  12 +请求示例
  13 +http://devapi.yoho.cn:58078/?app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=web.redution.add&uid=8040274&mobile=13211111111&productId=214217&client_secret=e1a7a55c91db35c3f494e39c650de8dc
  14 +
  15 +### 响应(data里所有的字段返回都是string类型)
  16 +code为200即为成功，否则是失败。
  17 +响应JSON格式如下所示:
  18 +```json
  19 +{
  20 + "alg": "SALT_MD5",
  21 + "code": 200,
  22 + "data": {
  23 + "num": 1,
  24 + "product_skns": [
  25 + 214217
  26 + ]
  27 + },
  28 + "md5": "77c2e3eb2763ac40dbb667d54781dd9b",
  29 + "message": "操作成功"
  30 +}
  31 +```
  32 +
  33 +## 2、取消订阅降价通知接口##
  34 +
  35 +取消订阅降价通知接口（method=web.redution.cancel）
  36 +#### 请求参数
  37 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  38 +|:-------| -----:|-----:|-----:|-----:|----:|
  39 +|uid|int|否|213|0|用户id|
  40 +|productIds|int|否|214217,214217|0|商品id|
  41 +
  42 +注意，通用的头部没有列出。
  43 +请求示例
  44 +http://devapi.yoho.cn:58078/?debug=XYZ&app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=web.redution.cancel&uid=8040274&productIds=119277&client_secret=3f31be8d35adb60425882cbb7298afa9
  45 +### 响应(data里所有的字段返回都是string类型)
  46 +code为200即为成功，否则是失败。
  47 +响应JSON格式如下所示:
  48 +```json
  49 +{
  50 + "alg": "SALT_MD5",
  51 + "code": 200,
  52 + "data": {
  53 + "num": 1
  54 + },
  55 + "md5": "77c2e3eb2763ac40dbb667d54781dd9b",
  56 + "message": "操作成功"
  57 +}
  58 +```
  59 +## 3、查询订阅降价数量接口##
  60 +
  61 +查询订阅降价数量接口（method=web.redution.count）
  62 +#### 请求参数
  63 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  64 +|:-------| -----:|-----:|-----:|-----:|----:|
  65 +|uid|int|否|213|0|用户id|
  66 +
  67 +注意，通用的头部没有列出。
  68 +请求示例
  69 +http://devapi.yoho.cn:58078/?debug=XYZ&method=web.redution.count&uid=706730&v=7
  70 +### 响应(data里所有的字段返回都是string类型)
  71 +code为200即为成功，否则是失败。
  72 +响应JSON格式如下所示:
  73 +```json
  74 +{
  75 + "alg": "SALT_MD5",
  76 + "code": 200,
  77 + "data": {
  78 + "num": 1
  79 + },
  80 + "md5": "77c2e3eb2763ac40dbb667d54781dd9b",
  81 + "message": "操作成功"
  82 +}
  83 +```
  1 +## 1、PC查询用户收藏商品列表接口##
  2 +
  3 +（method=web.favorite.product）
  4 +#### 请求参数
  5 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|----:|
  7 +|uid|int|否|3407014|0|用户id|
  8 +|limit|int|是|500|10|返回记录数|
  9 +
  10 +注意，通用的头部没有列出。
  11 +请求示例
  12 +http://devapi.yoho.cn:58078/?debug=XYZ&app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=web.favorite.product&uid=3407014&limit=500
  13 +
  14 +### 响应
  15 +code为200即为成功，否则是失败。
  16 +响应JSON格式如下所示:
  17 +```json
  18 +{
  19 + "alg": "SALT_MD5",
  20 + "code": 200,
  21 + "data": {
  22 + "category_list": [
  23 + {
  24 + "category_id": 1,
  25 + "category_name": "上衣",
  26 + "num": 2
  27 + }
  28 + ],
  29 + "product_list": [
  30 + {
  31 + "attribute": 0,
  32 + "category_id": 1,
  33 + "cnAlphabet": "FLYDFLYDA502TE16DuanXiuTXu",
  34 + "fav_price": "199.00",
  35 + "goodsId": 246351,
  36 + "image": "http://img13.static.yhbimg.com/goodsimg/2015/05/05/02/02a4f22b5dd8902ff265540d8cbd7a29a8.jpg?imageMogr2/thumbnail/160x200/extent/160x200/background/d2hpdGU=/position/center/quality/80",
  37 + "is_join_promotion": "Y",
  38 + "is_price_down": "N",
  39 + "is_subscribe_reduction": "N",
  40 + "market_price": "199.00",
  41 + "price_down": 0,
  42 + "product_id": 181867,
  43 + "product_name": "F.L.Y.D 剪裁印花长款短袖T恤[修身弹力棉]",
  44 + "product_skn": 51106081,
  45 + "product_url": "http://www.yohobuy.com/product/pro_181867_246351/FLYDFLYDA502TE16DuanXiuTXu.html",
  46 + "promotion_list": [
  47 + {
  48 + "promotion_title": "全场59加价购-WEB重构",
  49 + "promotion_type": "加价购"
  50 + },
  51 + {
  52 + "promotion_title": "全场39加价购-WEB重构",
  53 + "promotion_type": "加价购"
  54 + }
  55 + ],
  56 + "sales_price": "199.00",
  57 + "status": 1,
  58 + "storage": 0
  59 + },
  60 + {
  61 + "attribute": 0,
  62 + "category_id": 1,
  63 + "cnAlphabet": "SKINARTSERIESINN201503009DaXiangTEEBai",
  64 + "fav_price": "229.00",
  65 + "goodsId": 221659,
  66 + "image": "http://img12.static.yhbimg.com/goodsimg/2015/03/17/09/024462dc4a951f93066907c8c23df27c95.jpg?imageMogr2/thumbnail/160x200/extent/160x200/background/d2hpdGU=/position/center/quality/80",
  67 + "is_join_promotion": "Y",
  68 + "is_price_down": "Y",
  69 + "is_subscribe_reduction": "N",
  70 + "market_price": "458.00",
  71 + "price_down": 0,
  72 + "product_id": 162553,
  73 + "product_name": "Skin Art Series INN 白色大象印花 TEE",
  74 + "product_skn": 51096290,
  75 + "product_url": "http://www.yohobuy.com/product/pro_162553_221659/SKINARTSERIESINN201503009DaXiangTEEBai.html",
  76 + "promotion_list": [
  77 + {
  78 + "promotion_title": "全场59加价购-WEB重构",
  79 + "promotion_type": "加价购"
  80 + },
  81 + {
  82 + "promotion_title": "全场39加价购-WEB重构",
  83 + "promotion_type": "加价购"
  84 + }
  85 + ],
  86 + "sales_price": "219.00",
  87 + "status": 1,
  88 + "storage": 1
  89 + }
  90 + ],
  91 + "total": 2
  92 + },
  93 + "md5": "7b1910d6696b7a1915ebd95029f888bc",
  94 + "message": "favorite product list"
  95 +}
  96 +```
  97 +
  98 +## 2、PC取消商品收藏接口##
  99 +
  100 +（method=web.favorite.cancel）
  101 +#### 请求参数
  102 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  103 +|:-------| -----:|-----:|-----:|-----:|----:|
  104 +|uid|int|否|8040274|0|用户id|
  105 +|favIds|int|否|212403,228841|null|商品id列表|
  106 +|type|String|否|product|null|收藏类型|
  107 +
  108 +注意，通用的头部没有列出。
  109 +请求示例
  110 +http://devapi.yoho.cn:58078/?debug=XYZ&app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=web.favorite.cancel&uid=8040274&favIds=212403,228841&type=product&client_secret=3f31be8d35adb60425882cbb7298afa9
  111 +### 响应
  112 +code为200即为成功，否则是失败。
  113 +响应JSON格式如下所示:
  114 +```json
  115 +{
  116 + "alg": "SALT_MD5",
  117 + "code": 200,
  118 + "data": [],
  119 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  120 + "message": "取消收藏成功"
  121 +}
  122 +```
  123 +
  124 +## 2、PC取消商品收藏接口##
  125 +
  126 +（method=web.favorite.cancel）
  127 +#### 请求参数
  128 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  129 +|:-------| -----:|-----:|-----:|-----:|----:|
  130 +|uid|int|否|3385902|0|用户id|
  131 +|favIds|int|否|46,175|null|品牌id列表|
  132 +|type|String|否|brand|null|收藏类型|
  133 +
  134 +注意，通用的头部没有列出。
  135 +请求示例
  136 +http://devapi.yoho.cn:58078/?debug=XYZ&app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=web.favorite.cancel&uid=3385902&favIds=46,175&type=brand&client_secret=3f31be8d35adb60425882cbb7298afa9
  137 +### 响应
  138 +code为200即为成功，否则是失败。
  139 +响应JSON格式如下所示:
  140 +```json
  141 +{
  142 + "alg": "SALT_MD5",
  143 + "code": 200,
  144 + "data": [],
  145 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  146 + "message": "取消收藏成功"
  147 +}
  148 +```
1 -## 1、获取用户签到信息##  
2 -  
3 -获取文章作者信息（method=app.sign.userSign）  
4 -#### 请求参数  
5 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
6 -|:-------| -----:|-----:|-----:|-----:|----:|  
7 -|uid|int|否|213|0|用户id|  
8 -  
9 -注意，通用的头部没有列出。  
10 -请求示例  
11 -http://192.168.102.217:8080/gateway/?method=app.sign.userSignInfo&uid=213&debug=XYZ  
12 -  
13 -### 响应(data里所有的字段返回都是string类型)  
14 -code为200即为成功，否则是失败。  
15 -响应JSON格式如下所示:  
16 -```json  
17 -{  
18 - "alg": "SALT_MD5",  
19 - "code": 200,  
20 - "data": {  
21 - "constantDay": "1",  
22 - "pushFlag": "1",  
23 - "signInfoList": [  
24 - {  
25 - "constantDay": "1",  
26 - "dateKey": "Today",  
27 - "signed": "true",  
28 - "today": "true",  
29 - "yohoCoinNum": "5"  
30 - },  
31 - {  
32 - "constantDay": "2",  
33 - "dateKey": "3.25",  
34 - "signed": "false",  
35 - "today": "false",  
36 - "yohoCoinNum": "10"  
37 - },  
38 - {  
39 - "constantDay": "3",  
40 - "dateKey": "3.26",  
41 - "signed": "false",  
42 - "today": "false",  
43 - "yohoCoinNum": "10"  
44 - },  
45 - {  
46 - "constantDay": "4",  
47 - "dateKey": "3.27",  
48 - "signed": "false",  
49 - "today": "false",  
50 - "yohoCoinNum": "15"  
51 - },  
52 - {  
53 - "constantDay": "5",  
54 - "dateKey": "3.28",  
55 - "signed": "false",  
56 - "today": "false",  
57 - "yohoCoinNum": "15"  
58 - },  
59 - {  
60 - "constantDay": "6",  
61 - "dateKey": "3.29",  
62 - "signed": "false",  
63 - "today": "false",  
64 - "yohoCoinNum": "20"  
65 - },  
66 - {  
67 - "constantDay": "7",  
68 - "dateKey": "3.30",  
69 - "signed": "false",  
70 - "today": "false",  
71 - "yohoCoinNum": "100"  
72 - }  
73 - ],  
74 - "todayCanGainYohoCoinNum": "5",  
75 - "todayKey": "3.24",  
76 - "todaySigned": "true",  
77 - "tomorrowCanGainYohoCoinNum": "10",  
78 - "totalYohoCoinNum": "5",  
79 - "uid": "213"  
80 - },  
81 - "md5": "7518388918692bfd92ea26f972fc89f7",  
82 - "message": "获取签到信息成功"  
83 -}  
84 -```  
85 -  
86 -## 2、用户签到接口##  
87 -  
88 -获取文章作者信息（method=app.sign.userSign）  
89 -#### 请求参数  
90 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
91 -|:-------| -----:|-----:|-----:|-----:|----:|  
92 -|uid|int|否|213|0|用户id|  
93 -  
94 -注意，通用的头部没有列出。  
95 -请求示例  
96 -http://192.168.102.217:8080/gateway/?method=app.sign.userSign&uid=213&debug=XYZ  
97 -  
98 -### 响应(data里所有的字段返回都是string类型)  
99 -code为200即为成功，否则是失败。  
100 -响应JSON格式如下所示:  
101 -```json  
102 -{  
103 - "code": 500,  
104 - "message": "用户已经签到过"  
105 -}  
106 -```  
107 -或者  
108 -```json  
109 -{  
110 - "alg": "SALT_MD5",  
111 - "code": 200,  
112 - "data": {  
113 - "gainYohoCoinNum": "5",  
114 - "totalYohoCoinNum": "5",  
115 - "uid": "215"  
116 - },  
117 - "md5": "01620cc59749b4a09571dad331136736",  
118 - "message": "用户签到成功"  
119 -}  
120 -```  
121 -  
122 -## 3、用户开启/关闭推送##  
123 -  
124 -获取文章作者信息（method=app.sign.changePushFlag）  
125 -#### 请求参数  
126 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
127 -|:-------| -----:|-----:|-----:|-----:|----:|  
128 -|uid|int|否|213|0|用户id|  
129 -|pushFlag|int|否|1|0|0:关闭推送1：开启推送|  
130 -  
131 -注意，通用的头部没有列出。  
132 -请求示例  
133 -http://192.168.102.217:8080/gateway/?method=app.sign.changePushFlag&uid=213&pushFlag=1&debug=XYZ  
134 -  
135 -### 响应  
136 -code为200即为成功，否则是失败。  
137 -响应JSON格式如下所示:  
138 -```json  
139 -{  
140 - "alg": "SALT_MD5",  
141 - "code": 200,  
142 - "data": [],  
143 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
144 - "message": "修改成功"  
145 -}  
146 -``` 1 +## 1、获取用户签到信息##
  2 +
  3 +获取用户签到信息（method=app.sign.userSignInfo）
  4 +#### 请求参数
  5 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|----:|
  7 +|uid|int|否|213|0|用户id|
  8 +
  9 +注意，通用的头部没有列出。
  10 +请求示例
  11 +http://192.168.102.217:8080/gateway/?method=app.sign.userSignInfo&uid=213&debug=XYZ
  12 +
  13 +### 响应(data里所有的字段返回都是string类型)
  14 +code为200即为成功，否则是失败。
  15 +响应JSON格式如下所示:
  16 +```json
  17 +{
  18 + "alg": "SALT_MD5",
  19 + "code": 200,
  20 + "data": {
  21 + "constantDay": "1",
  22 + "pushFlag": "1",
  23 + "signInfoList": [
  24 + {
  25 + "constantDay": "1",
  26 + "dateKey": "Today",
  27 + "signed": "true",
  28 + "today": "true",
  29 + "yohoCoinNum": "5"
  30 + },
  31 + {
  32 + "constantDay": "2",
  33 + "dateKey": "3.25",
  34 + "signed": "false",
  35 + "today": "false",
  36 + "yohoCoinNum": "10"
  37 + },
  38 + {
  39 + "constantDay": "3",
  40 + "dateKey": "3.26",
  41 + "signed": "false",
  42 + "today": "false",
  43 + "yohoCoinNum": "10"
  44 + },
  45 + {
  46 + "constantDay": "4",
  47 + "dateKey": "3.27",
  48 + "signed": "false",
  49 + "today": "false",
  50 + "yohoCoinNum": "15"
  51 + },
  52 + {
  53 + "constantDay": "5",
  54 + "dateKey": "3.28",
  55 + "signed": "false",
  56 + "today": "false",
  57 + "yohoCoinNum": "15"
  58 + },
  59 + {
  60 + "constantDay": "6",
  61 + "dateKey": "3.29",
  62 + "signed": "false",
  63 + "today": "false",
  64 + "yohoCoinNum": "20"
  65 + },
  66 + {
  67 + "constantDay": "7",
  68 + "dateKey": "3.30",
  69 + "signed": "false",
  70 + "today": "false",
  71 + "yohoCoinNum": "100"
  72 + }
  73 + ],
  74 + "todayCanGainYohoCoinNum": "5",
  75 + "todayKey": "3.24",
  76 + "todaySigned": "true",
  77 + "tomorrowCanGainYohoCoinNum": "10",
  78 + "totalYohoCoinNum": "5",
  79 + "uid": "213"
  80 + },
  81 + "md5": "7518388918692bfd92ea26f972fc89f7",
  82 + "message": "获取签到信息成功"
  83 +}
  84 +```
  85 +
  86 +## 2、用户签到接口##
  87 +
  88 +用户签到接口（method=app.sign.userSign）
  89 +#### 请求参数
  90 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  91 +|:-------| -----:|-----:|-----:|-----:|----:|
  92 +|uid|int|否|213|0|用户id|
  93 +
  94 +注意，通用的头部没有列出。
  95 +请求示例
  96 +http://192.168.102.217:8080/gateway/?method=app.sign.userSign&uid=213&debug=XYZ
  97 +
  98 +### 响应(data里所有的字段返回都是string类型)
  99 +code为200即为成功，否则是失败。
  100 +响应JSON格式如下所示:
  101 +```json
  102 +{
  103 + "code": 500,
  104 + "message": "用户已经签到过"
  105 +}
  106 +```
  107 +或者
  108 +```json
  109 +{
  110 + "alg": "SALT_MD5",
  111 + "code": 200,
  112 + "data": {
  113 + "gainYohoCoinNum": "5",
  114 + "totalYohoCoinNum": "5",
  115 + "uid": "215"
  116 + },
  117 + "md5": "01620cc59749b4a09571dad331136736",
  118 + "message": "用户签到成功"
  119 +}
  120 +```
  121 +
  122 +## 3、用户开启/关闭推送##
  123 +
  124 +用户开启/关闭推送（method=app.sign.changePushFlag）
  125 +#### 请求参数
  126 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  127 +|:-------| -----:|-----:|-----:|-----:|----:|
  128 +|uid|int|否|213|0|用户id|
  129 +|pushFlag|int|否|1|0|0:关闭推送1：开启推送|
  130 +
  131 +注意，通用的头部没有列出。
  132 +请求示例
  133 +http://192.168.102.217:8080/gateway/?method=app.sign.changePushFlag&uid=213&pushFlag=1&debug=XYZ
  134 +
  135 +### 响应
  136 +code为200即为成功，否则是失败。
  137 +响应JSON格式如下所示:
  138 +```json
  139 +{
  140 + "alg": "SALT_MD5",
  141 + "code": 200,
  142 + "data": [],
  143 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  144 + "message": "修改成功"
  145 +}
  146 +```
  1 +# 物流服务接口
  2 +
  3 +## 接口列表
  4 +| 接口名称 | 接口描述 |
  5 +| --------| -------- |
  6 +|[app.express.getExpressCompany](#1)|获取物流公司列表|
  7 +|[app.express.getNewExpress](#2)|获取最新退换货物流信息|
  8 +|[app.express.getRefundExpress](#3)|获取退换货物流信息|
  9 +
  10 +
  11 +## 接口描述
  12 +
  13 +### 1、获取物流公司列表(app.express.getExpressCompany)
  14 +
  15 +#### 请求参数
  16 +| Param Name | Param Type | Required | Param Value | Desc |
  17 +| :-- | --: | --: | --: | --: |
  18 +| method | String | true | app.express.getExpressCompany| 请求方法|
  19 +| status | int | false | 1(默认值) | 物流公司启用状态 1开启，0关闭 默认开启 |
  20 +
  21 +#### 响应内容 按公司首字母排序
  22 +```json
  23 +{
  24 + "code": 200,
  25 + "data": {
  26 + "E": [
  27 + {
  28 + "company_alif": "E",
  29 + "company_code": "ems",
  30 + "company_name": "南京ems",
  31 + "company_name_substr": "南京ems",
  32 + "id": 2,
  33 + "is_first": "Y"
  34 + }
  35 + ],
  36 + "H": [
  37 + {
  38 + "company_alif": "H",
  39 + "company_code": "huitongkuaidi",
  40 + "company_name": "汇通快运",
  41 + "company_name_substr": "汇通快运",
  42 + "id": 37,
  43 + "is_first": "Y"
  44 + }
  45 + ],
  46 + "J": [
  47 + {
  48 + "company_alif": "J",
  49 + "company_code": "jd",
  50 + "company_name": "京东快递",
  51 + "company_name_substr": "京东快递",
  52 + "id": 46,
  53 + "is_first": "Y"
  54 + }
  55 + ],
  56 + "S": [
  57 + {
  58 + "company_alif": "S",
  59 + "company_code": "shunfeng",
  60 + "company_name": "顺丰",
  61 + "company_name_substr": "顺丰",
  62 + "id": 23,
  63 + "is_first": "Y"
  64 + },
  65 + {
  66 + "company_alif": "S",
  67 + "company_code": "shentong",
  68 + "company_name": "申通",
  69 + "company_name_substr": "申通",
  70 + "id": 36,
  71 + "is_first": "N"
  72 + }
  73 + ],
  74 + "T": [
  75 + {
  76 + "company_alif": "T",
  77 + "company_code": "tonghetianxia",
  78 + "company_name": "通和天下",
  79 + "company_name_substr": "通和天下",
  80 + "id": 30,
  81 + "is_first": "Y"
  82 + }
  83 + ],
  84 + "Y": [
  85 + {
  86 + "company_alif": "Y",
  87 + "company_code": "yuantong",
  88 + "company_name": "圆通",
  89 + "company_name_substr": "圆通",
  90 + "id": 29,
  91 + "is_first": "Y"
  92 + },
  93 + {
  94 + "company_alif": "Y",
  95 + "company_code": "youshuwuliu",
  96 + "company_name": "优速快递",
  97 + "company_name_substr": "优速快递",
  98 + "id": 32,
  99 + "is_first": "N"
  100 + },
  101 + {
  102 + "company_alif": "Y",
  103 + "company_code": "yunda",
  104 + "company_name": "韵达",
  105 + "company_name_substr": "韵达",
  106 + "id": 39,
  107 + "is_first": "N"
  108 + }
  109 + ],
  110 + "Z": [
  111 + {
  112 + "company_alif": "Z",
  113 + "company_code": "zhaijisong",
  114 + "company_name": "南京ZJS",
  115 + "company_name_substr": "南京ZJS",
  116 + "id": 5,
  117 + "is_first": "Y"
  118 + }
  119 + ]
  120 + },
  121 + "md5": "c773c50ba3acedff6feacace3f95e468",
  122 + "message": "物流公司"
  123 +}
  124 +```
  125 +##### 响应内容描述
  126 +| Param Name | Param Type | Desc |
  127 +| ---------- | ---------- | ---- |
  128 +| company_alif | String | 物流公司首字母 |
  129 +| company_code | String | 物流公司编码|
  130 +| company_name | String | 物流公司名称 |
  131 +| company_name_substr| String | 物流公司子字符串 |
  132 +| id | int |物流公司ID |
  133 +| is_first | String |是否首次 |
  134 +
  135 +### 2、获取最新退换货物流信息(app.express.getNewExpress)
  136 +
  137 +#### 请求参数
  138 +| Param Name | Param Type | Required | Param Value | Desc |
  139 +| :-- | --: | --: | --: | --: |
  140 +| method | String | true | app.express.getNewExpress| 请求方法|
  141 +| id | int |true | 428106 | 退换货申请ID|
  142 +| uid | int |true | 362719 |用户ID |
  143 +| type | String |true | refund | 类型 （退货：refund,换货：change）|
  144 +
  145 +#### 响应内容 按公司首字母排序
  146 +```json
  147 +{
  148 + "code": 200,
  149 + "message": "成功获取物流信息",
  150 + "data": {
  151 + "url": "http://www.ems.com.cn/",
  152 + "logo": "http://img12.static.yhbimg.com/taobaocms/2015/08/17/07/02fa410769cbbc3c4b59d6a804a3b8d98e.png",
  153 + "caption": "南京ems",
  154 + "is_support": "3",
  155 + "express_number": "44323566",
  156 + "express_detail": []
  157 + },
  158 + "md5": "3fc5f5f1ea744d14ad4c4ae54e7cf143"
  159 +}
  160 +
  161 +```
  162 +##### 响应内容描述
  163 +| Param Name | Param Type | Desc |
  164 +| ---------- | ---------- | ---- |
  165 +| url | String | 物流公司网址 |
  166 +| logo | String | 物流公司logo|
  167 +| caption | String | 物流公司名称 |
  168 +| is_support | String|返回状态(1:查询到物流信息 2:不支持物流公司 3:没有找到物流信息) |
  169 +| express_number| String | 快递单号 |
  170 +| express_detail | json数组 |物流详情 |
  171 +
  172 +### 3、获取退换货物流信息(app.express.getRefundExpress)
  173 +
  174 +#### 请求参数
  175 +| Param Name | Param Type | Required | Param Value | Desc |
  176 +| :-- | --: | --: | --: | --: |
  177 +| method | String | true | app.express.getRefundExpress| 请求方法|
  178 +| express_id | int |true | 23 | 快递公司ID|
  179 +| express_number | String |true | 800481228670 |快递单号 |
  180 +
  181 +#### 响应内容 按公司首字母排序
  182 +```json
  183 +{
  184 + "code": 200,
  185 + "data": [
  186 + {
  187 + "acceptTime": "2014-12-06 12:38:24",
  188 + "accept_address": "客户 签收人: 林汐 已签收",
  189 + "express_id": 3,
  190 + "express_number": "800481228670",
  191 + "order_code": 412506421
  192 + },
  193 + {
  194 + "acceptTime": "2014-12-06 08:58:31",
  195 + "accept_address": "北京市通州区城区公司 派件人: 徐宏博 派件中 派件员电话18911353205",
  196 + "express_id": 3,
  197 + "express_number": "800481228670",
  198 + "order_code": 412506421
  199 + },
  200 + {
  201 + "acceptTime": "2014-12-06 07:51:43",
  202 + "accept_address": "快件到达 北京市通州区城区公司",
  203 + "express_id": 3,
  204 + "express_number": "800481228670",
  205 + "order_code": 412506421
  206 + },
  207 + {
  208 + "acceptTime": "2014-12-05 18:28:25",
  209 + "accept_address": "北京转运中心公司 已发出,下一站 北京市通州区城区",
  210 + "express_id": 3,
  211 + "express_number": "800481228670",
  212 + "order_code": 412506421
  213 + },
  214 + {
  215 + "acceptTime": "2014-12-05 18:26:21",
  216 + "accept_address": "快件到达 北京转运中心公司",
  217 + "express_id": 3,
  218 + "express_number": "800481228670",
  219 + "order_code": 412506421
  220 + },
  221 + {
  222 + "acceptTime": "2014-12-04 19:44:16",
  223 + "accept_address": "江苏省南京市雨花区板桥公司 已打包,发往下一站 北京转运中心",
  224 + "express_id": 3,
  225 + "express_number": "800481228670",
  226 + "order_code": 412506421
  227 + },
  228 + {
  229 + "acceptTime": "2014-12-04 18:44:41",
  230 + "accept_address": "快件到达 江苏省南京市雨花区板桥公司",
  231 + "express_id": 3,
  232 + "express_number": "800481228670",
  233 + "order_code": 412506421
  234 + }
  235 + ],
  236 + "md5": "74b36d9c9b9ff658eac1b46c196dbc99",
  237 + "message": "物流信息"
  238 +```
  239 +##### 响应内容描述
  240 +| Param Name | Param Type | Desc |
  241 +| ---------- | ---------- | ---- |
  242 +| acceptTime | String | 运货单创建时间 |
  243 +| accept_address | String | 运货单接收地址|
  244 +| express_id | int | 快递公司ID|
  245 +| express_number | String |快递单号 |
  246 +| order_code| long | 订单号 |
  1 +# 退货服务接口
  2 +
  3 +## 接口列表
  4 +| 接口名称 | 接口描述 |
  5 +| --------| -------- |
  6 +|[app.refund.goodsList](#1)|获取退货订单商品列表|
  7 +|[app.refund.submit](#2)|提交退货申请|
  8 +|[app.refund.detail](#3)|退货详情|
  9 +|[app.refund.setexpress](#4)|保存快递信息|
  10 +
  11 +
  12 +## 接口描述
  13 +
  14 +### 1、获取退货订单商品列表(app.refund.goodsList)
  15 +
  16 +#### 请求参数
  17 +| Param Name | Param Type | Required | Param Value | Desc |
  18 +| :-- | --: | --: | --: | --: |
  19 +| method | String | true | app.refund.goodsList| 请求方法|
  20 +| uid | int | true | 7893817 |用户ID |
  21 +| order_code |long | true | 1613656852 |订单号 |
  22 +
  23 +#### 响应内容
  24 +```json
  25 +{
  26 + "code": 200,
  27 + "data": {
  28 + "coupon_amount": "0.00",
  29 + "goods_list": [
  30 + {
  31 + "color_name": "蓝色",
  32 + "goods_id": 355897,
  33 + "goods_image": "http://img10.static.yhbimg.com/goodsimg/2015/10/29/12/01c9c05a2170996e86f5c1f7ed32e48ac7.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  34 + "goods_type": "ordinary",
  35 + "goods_type_id": 1,
  36 + "hasShoes": 0,
  37 + "last_price": "149.00",
  38 + "product_id": 275357,
  39 + "product_name": "Life•After Life X The Simpsons 辛普森一家刺绣牛津纺衬衫",
  40 + "product_skc": 280039,
  41 + "product_skn": 51153138,
  42 + "product_sku": 894428,
  43 + "size_name": "M"
  44 + }
  45 + ],
  46 + "return_amount_info": "",
  47 + "return_amount_mode": [
  48 + {
  49 + "id": 1,
  50 + "is_default": "Y",
  51 + "name": "原卡返还"
  52 + }
  53 + ],
  54 + "return_reason": [
  55 + {
  56 + "id": 3,
  57 + "name": "不喜欢"
  58 + },
  59 + {
  60 + "id": 2,
  61 + "name": "性价比不高"
  62 + },
  63 + {
  64 + "id": 11,
  65 + "name": "价格变化"
  66 + },
  67 + {
  68 + "id": 4,
  69 + "name": "质量瑕疵"
  70 + },
  71 + {
  72 + "id": 1,
  73 + "name": "尺寸不合适"
  74 + },
  75 + {
  76 + "id": 7,
  77 + "name": "商品有色差"
  78 + },
  79 + {
  80 + "id": 8,
  81 + "name": "图片与实物不符"
  82 + },
  83 + {
  84 + "id": 6,
  85 + "name": "发错货"
  86 + },
  87 + {
  88 + "id": 5,
  89 + "name": "快递延迟"
  90 + }
  91 + ],
  92 + "yoho_coin_num": "0.00"
  93 + },
  94 + "md5": "72879cfb65bcd2705e4283d2f5dc1a30",
  95 + "message": "Refund goods list"
  96 +}
  97 +```
  98 +
  99 +
  100 +### 2、提交退货申请(app.refund.submit)
  101 +
  102 +#### 请求参数
  103 +| Param Name | Param Type | Required | Param Value | Desc |
  104 +| :-- | --: | --: | --: | --: |
  105 +| method | String | true |app.refund.submit| 请求方法|
  106 +| order_code |long | true | 1512253171 |订单号 |
  107 +| uid | int | true |8040274 |用户ID |
  108 +| area_code |String | false | ""(默认值) |地区编号|
  109 +| goods |String(json数组) | true | [{"goods_type":"1","last_price":"18.00","product_skc":"83007","product_skn":"51001899","product_sku":"307528","remark":"","returned_reason":1}] |退货商品 |
  110 +| payment |String(json对象) | true | {"alipay_account":"","alipay_name":"","area_code":"320115","bank_card":"","bank_name":"","city":"","payee_name":"","province":"","remark":"","return_amount_mode":"1"} |退款|
  111 +
  112 +#### 响应内容 按公司首字母排序
  113 +```json
  114 +{
  115 + "code": 200,
  116 + "message": "退货申请成功",
  117 + "data": {
  118 + "apply_id": "428135"
  119 + },
  120 + "md5": "2d4a86d3d308cf8cbdd9870ebd61a3a4"
  121 +}
  122 +```
  123 +##### 响应内容描述
  124 +| Param Name | Param Type | Desc |
  125 +| ---------- | ---------- | ---- |
  126 +| apply_id | String | 退货申请ID |
  127 +
  128 +
  129 +### 3、退货详情(app.refund.detail)
  130 +
  131 +#### 请求参数
  132 +| Param Name | Param Type | Required | Param Value | Desc |
  133 +| :-- | --: | --: | --: | --: |
  134 +| method | String | true | app.refund.detail| 请求方法|
  135 +| id |int | true | 428106 |退货申请ID |
  136 +| uid | int | true | 362719 |用户ID |
  137 +
  138 +
  139 +#### 响应内容
  140 +```json
  141 +{
  142 + "code": 200,
  143 + "message": "退货详情",
  144 + "data": {
  145 + "source_order_code": "1513540278",
  146 + "use_yoho_coin_num": null,
  147 + "status": "20",
  148 + "status_name": "商品寄回",
  149 + "statusList": [
  150 + {
  151 + "name": "提交申请",
  152 + "act": "Y"
  153 + },
  154 + {
  155 + "name": "审核通过",
  156 + "act": "Y"
  157 + },
  158 + {
  159 + "name": "商品寄回",
  160 + "act": "Y"
  161 + },
  162 + {
  163 + "name": "商品入库",
  164 + "act": "N"
  165 + },
  166 + {
  167 + "name": "退款完成",
  168 + "act": "N"
  169 + }
  170 + ],
  171 + "create_time": "2015-11-23 20:20:12",
  172 + "return_amount_mode_name": "YOHO币",
  173 + "return_amount_mode": "4",
  174 + "return_yoho_coin": "0",
  175 + "goods_list": [
  176 + {
  177 + "product_skn": "51146548",
  178 + "product_name": "我是可爱的小秋秋，james，蔡!",
  179 + "goods_image": "?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/90",
  180 + "size_name": null,
  181 + "color_name": null,
  182 + "sales_price": null,
  183 + "reason": "1",
  184 + "remark": "",
  185 + "reason_name": "尺寸不合适",
  186 + "evidence_images": [],
  187 + "goods_type": "ordinary"
  188 + }
  189 + ],
  190 + "notice": {
  191 + "id": 20,
  192 + "title": "商品寄回物流信息",
  193 + "express_company": "南京ems",
  194 + "express_number": "44323566"
  195 + },
  196 + "return_amount": "125.00",
  197 + "return_coupon_amount": "0.00",
  198 + "express_number": "44323566",
  199 + "return_amount_total": "125.00",
  200 + "return_amount_info": "",
  201 + "return_amount_mode_info": []
  202 + },
  203 + "md5": "6fa464cf72538ad2c25fa24d20dcdd20"
  204 +}
  205 +
  206 +}
  207 +```
  208 +
  209 +### 4、保存快递信息(app.refund.setexpress)
  210 +
  211 +#### 请求参数
  212 +| Param Name | Param Type | Required | Param Value | Desc |
  213 +| :-- | --: | --: | --: | --: |
  214 +| method | String | true | app.refund.setexpress| 请求方法|
  215 +| id |int | true | 428120 |退货申请ID |
  216 +| uid | int | true | 362729 |用户ID |
  217 +| express_company |String | true | 南京ems |快递公司名称|
  218 +| express_number |String | true | 44323575 |快递单号 |
  219 +| express_id |int | true | 2 |快递公司ID |
  220 +
  221 +#### 响应内容
  222 +```json
  223 +{
  224 + "code": 200,
  225 + "message": "快递单号设置成功",
  226 + "data": [],
  227 + "md5": "93311f762194b751872601b67fad53f7"
  228 +}
  229 +or
  230 +{
  231 + "code": 412,
  232 + "message": "没有找到该退货申请"
  233 +}
  234 +
  235 +```
@@ -275,13 +275,15 @@ code为200即为成功，否则是失败。 @@ -275,13 +275,15 @@ code为200即为成功，否则是失败。
275 #### 请求参数 275 #### 请求参数
276 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 276 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
277 |:-------| -----:|-----:|-----:|-----:|----:| 277 |:-------| -----:|-----:|-----:|-----:|----:|
278 -|client_type|string|否|iphone|-|客户端类型|  
279 -|gender|string|是|男|-|性别|  
280 -|page|int|否|1|-|页码|  
281 -|session_key|string|是|-|-|session key|  
282 -|sort_id|int|否|0|-|分类id|  
283 -|udid|string|否|-|-|udid|  
284 -|uid|Integer|是|1|-|uid| 278 +|sort_id|int|是|-|0|分类id|
  279 +|gender|string|是|-|emptyString|性别|
  280 +|author_id|int|是|1|0|作者id|
  281 +|tag|string|是|-|emptyString|标签|
  282 +|uid|int|是|25|0|uid|
  283 +|udid|String|是|-|emptyString|udid|
  284 +|client_type|String|是|iphone|h5|客户端类型|
  285 +|page|Integer|是|1|1|页码|
  286 +|limit|Integer|是|10|10|分页大小|
285 287
286 注意，通用的头部没有列出。 288 注意，通用的头部没有列出。
287 请求示例 289 请求示例