platform / yohobuy-doc · Commits

Go to a project

Authored by bblu
Commit 4ea07bd9606a39ea6602278d4a53a088e98501dd 1 parent fd9c8dd5

更新

Inline Side-by-side
Showing 1 changed file with 354 additions and 118 deletions
1 供应商接口服务定义 1 供应商接口服务定义
2 --------------------- 2 ---------------------
3 -#### 创建供应商页接口 3 +
  4 +
  5 +
  6 +## 创建供应商列表查询接口
4 7
5 > 接口名： '/supplier/supplier/getCreateSupplierList' 8 > 接口名： '/supplier/supplier/getCreateSupplierList'
6 9
7 -##### 入参 10 +### 入参
  11 +
  12 +-------------------------
8 |属性名称|类型|例子|说明| 13 |属性名称|类型|例子|说明|
9 |--------|----|----|----| 14 |--------|----|----|----|
10 -|id|int|10|id|  
11 -|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|  
12 -|timeSort|string|asc,desc|排序(asc:正序, desc:倒序)|  
13 -#### 返回 15 +|id|String|123|供应商ID|
  16 +|status|String|100|供应商状态（100：暂存，200：审核中，300：通过，900：驳回）|
  17 +|timeSort|String|asc|时间排序（asc：正序，desc：倒序）|
  18 +---------------------
  19 +
  20 +### 返回
14 21
15 ``` json 22 ``` json
16 { 23 {
17 - "code": 200,  
18 - "message": "请求成功",  
19 - "dade":[{  
20 - //id  
21 - "id":10,  
22 - //供应商名称  
23 - "supplierName":"南京新与力广告传媒",  
24 - // 更新时间  
25 - "updateTime":"2016-01-14 16:30:23",  
26 - // 供应商状态  
27 - "status":100,  
28 - // 是否冻结  
29 - "isFreeze":"Y",  
30 - // 最近操作  
31 - "operations":"1"  
32 - }] 24 + "code":200,
  25 + "message":"操作成功",
  26 + "data": {
  27 + "list": [
  28 + {
  29 + "id": "", 供应商ID
  30 + "supplierCode": "", 供应商编号
  31 + "supplierName": "", 供应商名称
  32 + "businessLicense": "", 营业执照电子版
  33 + "legalPerson": "", 法人姓名
  34 + "linkman": "", 联系人姓名
  35 + "phone": "", 联系人电话
  36 + "fax": "", 传真
  37 + "email": "", 邮箱
  38 + "url": "", 网址
  39 + "taxCertificate": "", 税务登记证电子版
  40 + "bankName": "", 开户行
  41 + "bankAccount": "", 开户账号
  42 + "category": "", 供应商类别
  43 + "createTime": "", 创建时间
  44 + "updateTime": "", 更新时间
  45 + "static_p": "",
  46 + "isLock": "",
  47 + "foundTime": "", 成立时间
  48 + "beginOperateTime": "", 经营开始时间
  49 + "endOperateTime": "", 经营结束时间
  50 + "isFreeze": "", 是否冻结（Y：是，N：否）
  51 + "status": "", 状态（100：暂存，200：审核中，300：通过，900：驳回）
  52 + "operations": "", 最近操作（1：创建，2：编辑，3：冻结，4：解冻）
  53 + "registeredAddress": "", 注册地址
  54 + "registeredCapital": "", 注册资本
  55 + "businessLicensePic": "", 组织机构代码证
  56 + "businessRange": "", 经营范围
  57 + "legalIdentityCard": "", 法人身份证电子
  58 + "createPid": "", 创建人
  59 + "contactPhone": "", 公司联系电话
  60 + "contactAddress": "", 公司联系地址
  61 + "accountOpeningLicense": "", 开户许可证电子版
  62 + "taxpayerQualificationCertificate": "", 纳税人资格证明电子版
  63 + "industryLicense": "" 行业许可证电子版
  64 + }
  65 + ],
  66 + "page": 0,
  67 + "size": 50,
  68 + "total": 1000,
  69 + "totalPage":20
  70 + }
33 } 71 }
34 72
35 ``` 73 ```
36 -#### 供应商列表页接口 74 +
  75 +
  76 +## 供应商列表查询接口
37 77
38 > 接口名： '/supplier/supplier/getManageSupplierList' 78 > 接口名： '/supplier/supplier/getManageSupplierList'
39 79
40 -##### 入参 80 +### 入参
  81 +
  82 +-------------------------
41 |属性名称|类型|例子|说明| 83 |属性名称|类型|例子|说明|
42 |--------|----|----|----| 84 |--------|----|----|----|
43 -|id|int|10|id|  
44 -|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|  
45 -|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)|  
46 -##### 返回  
47 -> 同创建供应商页接口  
48 -#### 供应商审核列表页接口 85 +|id|String|123|供应商ID|
  86 +|status|String|100|供应商状态（100：暂存，200：审核中，300：通过，900：驳回）|
  87 +|isFreeze|String|N|生效状态（N：已生效，Y：不生效）|
  88 +---------------------
  89 +
  90 +### 返回
  91 +
  92 +``` json
  93 +{
  94 + "code":200,
  95 + "message":"操作成功",
  96 + "data": {
  97 + "list": [
  98 + {
  99 + "id": "", 供应商ID
  100 + "supplierCode": "", 供应商编号
  101 + "supplierName": "", 供应商名称
  102 + "businessLicense": "", 营业执照电子版
  103 + "legalPerson": "", 法人姓名
  104 + "linkman": "", 联系人姓名
  105 + "phone": "", 联系人电话
  106 + "fax": "", 传真
  107 + "email": "", 邮箱
  108 + "url": "", 网址
  109 + "taxCertificate": "", 税务登记证电子版
  110 + "bankName": "", 开户行
  111 + "bankAccount": "", 开户账号
  112 + "category": "", 供应商类别
  113 + "createTime": "", 创建时间
  114 + "updateTime": "", 更新时间
  115 + "static_p": "",
  116 + "isLock": "",
  117 + "foundTime": "", 成立时间
  118 + "beginOperateTime": "", 经营开始时间
  119 + "endOperateTime": "", 经营结束时间
  120 + "isFreeze": "", 是否冻结（Y：是，N：否）
  121 + "status": "", 状态（100：暂存，200：审核中，300：通过，900：驳回）
  122 + "operations": "", 最近操作（1：创建，2：编辑，3：冻结，4：解冻）
  123 + "registeredAddress": "", 注册地址
  124 + "registeredCapital": "", 注册资本
  125 + "businessLicensePic": "", 组织机构代码证
  126 + "businessRange": "", 经营范围
  127 + "legalIdentityCard": "", 法人身份证电子
  128 + "createPid": "", 创建人
  129 + "contactPhone": "", 公司联系电话
  130 + "contactAddress": "", 公司联系地址
  131 + "accountOpeningLicense": "", 开户许可证电子版
  132 + "taxpayerQualificationCertificate": "", 纳税人资格证明电子版
  133 + "industryLicense": "" 行业许可证电子版
  134 + }
  135 + ],
  136 + "page": 0,
  137 + "size": 50,
  138 + "total": 1000,
  139 + "totalPage":20
  140 + }
  141 +}
  142 +
  143 +```
  144 +
  145 +
  146 +## 审核供应商列表查询接口
49 147
50 > 接口名： '/supplier/supplier/getAuditSupplierList' 148 > 接口名： '/supplier/supplier/getAuditSupplierList'
51 149
52 -##### 入参 150 +### 入参
  151 +
  152 +-------------------------
53 |属性名称|类型|例子|说明| 153 |属性名称|类型|例子|说明|
54 |--------|----|----|----| 154 |--------|----|----|----|
55 -|id|int|10|id|  
56 -##### 返回 155 +|id|String|123|供应商ID|
  156 +---------------------
57 157
58 -> 同创建供应商页接口 158 +### 返回
59 159
60 -#### 供应商新增编辑接口  
61 -> 接口名： '/supplier/supplier/addSupplier'  
62 -##### 入参 160 +``` json
  161 +{
  162 + "code":200,
  163 + "message":"操作成功",
  164 + "data": {
  165 + "list": [
  166 + {
  167 + "id": "", 供应商ID
  168 + "supplierCode": "", 供应商编号
  169 + "supplierName": "", 供应商名称
  170 + "businessLicense": "", 营业执照电子版
  171 + "legalPerson": "", 法人姓名
  172 + "linkman": "", 联系人姓名
  173 + "phone": "", 联系人电话
  174 + "fax": "", 传真
  175 + "email": "", 邮箱
  176 + "url": "", 网址
  177 + "taxCertificate": "", 税务登记证电子版
  178 + "bankName": "", 开户行
  179 + "bankAccount": "", 开户账号
  180 + "category": "", 供应商类别
  181 + "createTime": "", 创建时间
  182 + "updateTime": "", 更新时间
  183 + "static_p": "",
  184 + "isLock": "",
  185 + "foundTime": "", 成立时间
  186 + "beginOperateTime": "", 经营开始时间
  187 + "endOperateTime": "", 经营结束时间
  188 + "isFreeze": "", 是否冻结（Y：是，N：否）
  189 + "status": "", 状态（100：暂存，200：审核中，300：通过，900：驳回）
  190 + "operations": "", 最近操作（1：创建，2：编辑，3：冻结，4：解冻）
  191 + "registeredAddress": "", 注册地址
  192 + "registeredCapital": "", 注册资本
  193 + "businessLicensePic": "", 组织机构代码证
  194 + "businessRange": "", 经营范围
  195 + "legalIdentityCard": "", 法人身份证电子
  196 + "createPid": "", 创建人
  197 + "contactPhone": "", 公司联系电话
  198 + "contactAddress": "", 公司联系地址
  199 + "accountOpeningLicense": "", 开户许可证电子版
  200 + "taxpayerQualificationCertificate": "", 纳税人资格证明电子版
  201 + "industryLicense": "" 行业许可证电子版
  202 + }
  203 + ],
  204 + "page": 0,
  205 + "size": 50,
  206 + "total": 1000,
  207 + "totalPage":20
  208 + }
  209 +}
  210 +
  211 +```
  212 +
  213 +
  214 +## 获取供应商列表（id/name）接口
  215 +
  216 +> 接口名： '/supplier/supplier/getSupplierListByIdName'
  217 +
  218 +### 入参
  219 +
  220 +-------------------------
63 |属性名称|类型|例子|说明| 221 |属性名称|类型|例子|说明|
64 |--------|----|----|----| 222 |--------|----|----|----|
65 -|status|int|100|供应商状态(100:暂存,200:提交审核)|  
66 -|supplierName|String|nike|供应商名称|  
67 -|supplierCode|String|123456|营业执照号|  
68 -|foundTime|Date|2012-12-12|成立日期|  
69 -|beginOperateTime|Date|2012-12-12|经营开始时间|  
70 -|endOperateTime|Date|2012-12-12|经营结束时间|  
71 -|registeredAddress|string|澳门|公司注册地址|  
72 -|legalPerson|string|张三|法人代表姓名|  
73 -|registeredCapital|string|nike|注册资本|  
74 -|contactPhone|string|nike|公司联系电话|  
75 -|contactAddress|string|xx省xx市|公司联系地址|  
76 -||||必填项,选填项不在其中|  
77 -  
78 -##### 返回 223 +|idName|String|1054|供应商ID或供应商名称|
  224 +---------------------
  225 +
  226 +### 返回
  227 +
79 ``` json 228 ``` json
80 { 229 {
81 - "code": 200,  
82 - "message": "保存成功", 230 + "code":200,
  231 + "message":"操作成功",
  232 + "data": [
  233 + {
  234 + "id": "",
  235 + "text":""
  236 + }
  237 + ]
  238 +
83 } 239 }
84 240
85 ``` 241 ```
86 242
87 -#### 供应商审核接口  
88 -> 接口名： '/supplier/supplier/updateSupplier'  
89 243
90 -##### 入参 244 +## 获取供应商详情接口
  245 +
  246 +> 接口名： '/supplier/supplier/getSupplier'
  247 +
  248 +### 入参
  249 +
  250 +-------------------------
91 |属性名称|类型|例子|说明| 251 |属性名称|类型|例子|说明|
92 |--------|----|----|----| 252 |--------|----|----|----|
93 -|id|int|10|供应商名称|  
94 -|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|  
95 -##### 返回 253 +|id|String|1054|供应商ID|
  254 +---------------------
  255 +
  256 +### 返回
  257 +
96 ``` json 258 ``` json
97 { 259 {
98 - "code": 200,  
99 - "message": "提交成功", 260 + "code":200,
  261 + "message":"操作成功",
  262 + "data": {
  263 + "id": "", 供应商ID
  264 + "supplierCode": "", 供应商编号
  265 + "supplierName": "", 供应商名称
  266 + "businessLicense": "", 营业执照电子版
  267 + "legalPerson": "", 法人姓名
  268 + "linkman": "", 联系人姓名
  269 + "phone": "", 联系人电话
  270 + "fax": "", 传真
  271 + "email": "", 邮箱
  272 + "url": "", 网址
  273 + "taxCertificate": "", 税务登记证电子版
  274 + "bankName": "", 开户行
  275 + "bankAccount": "", 开户账号
  276 + "category": "", 供应商类别
  277 + "createTime": "", 创建时间
  278 + "updateTime": "", 更新时间
  279 + "static_p": "",
  280 + "isLock": "",
  281 + "foundTime": "", 成立时间
  282 + "beginOperateTime": "", 经营开始时间
  283 + "endOperateTime": "", 经营结束时间
  284 + "isFreeze": "", 是否冻结（Y：是，N：否）
  285 + "status": "", 状态（100：暂存，200：审核中，300：通过，900：驳回）
  286 + "operations": "", 最近操作（1：创建，2：编辑，3：冻结，4：解冻）
  287 + "registeredAddress": "", 注册地址
  288 + "registeredCapital": "", 注册资本
  289 + "businessLicensePic": "", 组织机构代码证
  290 + "businessRange": "", 经营范围
  291 + "legalIdentityCard": "", 法人身份证电子
  292 + "createPid": "", 创建人
  293 + "contactPhone": "", 公司联系电话
  294 + "contactAddress": "", 公司联系地址
  295 + "accountOpeningLicense": "", 开户许可证电子版
  296 + "taxpayerQualificationCertificate": "", 纳税人资格证明电子版
  297 + "industryLicense": "" 行业许可证电子版
  298 + }
100 } 299 }
101 300
102 ``` 301 ```
103 302
104 -#### 供应商冻结解冻接口  
105 -> 接口名： '/supplier/supplier/updateSupplier' 303 +## 新增供应商接口
  304 +
  305 +> 接口名： '/supplier/supplier/addSupplier'
  306 +
  307 +### 入参
106 308
107 -##### 入参 309 +-------------------------
108 |属性名称|类型|例子|说明| 310 |属性名称|类型|例子|说明|
109 |--------|----|----|----| 311 |--------|----|----|----|
110 -|id|int|10|供应商名称|  
111 -|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)|  
112 -##### 返回 312 +|id|int|43|供应商ID|
  313 +|supplierCode|String|-|供应商编号|
  314 +|supplierName|String|-|供应商名称|
  315 +|businessLicense|String|-|营业执照电子版|
  316 +|legalPerson|String|张三|法人姓名|
  317 +|linkman|String|李四|联系人姓名|
  318 +|phone|String|-|联系人电话|
  319 +|fax|String|-|传真|
  320 +|email|String|-|邮箱|
  321 +|url|String|-|网址|
  322 +|taxCertificate|String|-|税务登记证电子版|
  323 +|bankName|String|-|开户行|
  324 +|bankAccount|String|-|开户账号|
  325 +|category|int|-|供应商类别|
  326 +|createTime|String|2011-10-12|创建时间|
  327 +|updateTime|String|2011-11-12|更新时间|
  328 +|static_p|int|-|-|
  329 +|isLock|int|-|-|
  330 +|foundTime|String|2001-10-10|成立时间|
  331 +|beginOperateTime|String|2001-12-21|经营开始时间|
  332 +|endOperateTime|String|2100-02-12|经营结束时间|
  333 +|isFreeze|String|N|是否冻结（Y：是，N：否）|
  334 +|status|int|200|状态（100：暂存，200：审核中，300：通过，900：驳回）|
  335 +|operations|int|1|最近操作（1：创建，2：编辑，3：冻结，4：解冻）|
  336 +|registeredAddress|String|-|注册地址|
  337 +|registeredCapital|String|5551166|注册资本|
  338 +|businessLicensePic|String|-|组织机构代码证|
  339 +|businessRange|String|-|经营范围|
  340 +|legalIdentityCard|String|-|法人身份证电子|
  341 +|createPid|int|43|创建人|
  342 +|contactPhone|String|-|公司联系电话|
  343 +|contactAddress|String|-|公司联系地址|
  344 +|accountOpeningLicenseid|String|-|开户许可证电子版|
  345 +|itaxpayerQualificationCertificated|String|-|纳税人资格证明电子版|
  346 +|industryLicense|String|-|行业许可证电子版|
  347 +---------------------
  348 +
  349 +### 返回
  350 +
113 ``` json 351 ``` json
114 { 352 {
115 - "code": 200,  
116 - "message": "修改成功", 353 + "code":200,
  354 + "message":"新增成功"
117 } 355 }
118 356
119 ``` 357 ```
120 -##### 查看供应商接口  
121 -> 接口名： '/supplier/supplier/getSupplier'  
122 358
123 -##### 入参 359 +
  360 +## 修改供应商接口
  361 +
  362 +> 接口名： '/supplier/supplier/updateSupplier'
  363 +
  364 +### 入参
  365 +
  366 +-------------------------
124 |属性名称|类型|例子|说明| 367 |属性名称|类型|例子|说明|
125 |--------|----|----|----| 368 |--------|----|----|----|
126 -|id|int|123|id| 369 +|id|int|43|供应商ID|
  370 +|supplierCode|String|-|供应商编号|
  371 +|supplierName|String|-|供应商名称|
  372 +|businessLicense|String|-|营业执照电子版|
  373 +|legalPerson|String|张三|法人姓名|
  374 +|linkman|String|李四|联系人姓名|
  375 +|phone|String|-|联系人电话|
  376 +|fax|String|-|传真|
  377 +|email|String|-|邮箱|
  378 +|url|String|-|网址|
  379 +|taxCertificate|String|-|税务登记证电子版|
  380 +|bankName|String|-|开户行|
  381 +|bankAccount|String|-|开户账号|
  382 +|category|int|-|供应商类别|
  383 +|createTime|String|2011-10-12|创建时间|
  384 +|updateTime|String|2011-11-12|更新时间|
  385 +|static_p|int|-|-|
  386 +|isLock|int|-|-|
  387 +|foundTime|String|2001-10-10|成立时间|
  388 +|beginOperateTime|String|2001-12-21|经营开始时间|
  389 +|endOperateTime|String|2100-02-12|经营结束时间|
  390 +|isFreeze|String|N|是否冻结（Y：是，N：否）|
  391 +|status|int|200|状态（100：暂存，200：审核中，300：通过，900：驳回）|
  392 +|operations|int|1|最近操作（1：创建，2：编辑，3：冻结，4：解冻）|
  393 +|registeredAddress|String|-|注册地址|
  394 +|registeredCapital|String|5551166|注册资本|
  395 +|businessLicensePic|String|-|组织机构代码证|
  396 +|businessRange|String|-|经营范围|
  397 +|legalIdentityCard|String|-|法人身份证电子|
  398 +|createPid|int|43|创建人|
  399 +|contactPhone|String|-|公司联系电话|
  400 +|contactAddress|String|-|公司联系地址|
  401 +|accountOpeningLicenseid|String|-|开户许可证电子版|
  402 +|itaxpayerQualificationCertificated|String|-|纳税人资格证明电子版|
  403 +|industryLicense|String|-|行业许可证电子版|
  404 +---------------------
127 405
128 -##### 返回 406 +### 返回
129 407
130 ``` json 408 ``` json
131 { 409 {
132 - //公司名称  
133 - "supplierName":"南京新与力广告传媒",  
134 - // 营业执照号  
135 - "supplierCode":"1234567890",  
136 - // 成立日期  
137 - "foundTime":"2015-1-1",  
138 - // 营业期限-start  
139 - "beginOperateTime":"2015-1-1",  
140 - // 营业期限-end  
141 - "endOperateTime":"2020-1-1",  
142 - // 注册所在地  
143 - "registeredAddress":"中华民国",  
144 - // 法人代表姓名  
145 - "legalPerson":"XXX",  
146 - // 法人身份证电子版  
147 - "legalIdentityCard":"https://www.baidu.com/img/baidu_jgylogo3.gif",  
148 - // 注册资本  
149 - "registeredCapital":"1W",  
150 - // 营业执照电子版  
151 - "":"https://www.baidu.com/img/baidu_jgylogo3.gif",  
152 - // 经营许可证  
153 - "":"https://www.baidu.com/img/baidu_jgylogo3.gif",  
154 - // 税务登记证  
155 - "":"https://www.baidu.com/img/baidu_jgylogo3.gif",  
156 - // 经营范围  
157 - "businessRange":"小吃",  
158 - // 公司联系电话  
159 - "contactPhone":"00100100",  
160 - // 公司联系地址  
161 - "contactAddress":"XX省XX市XXX街道10号",  
162 - // 联系人  
163 - "linkman":"XXX",  
164 - // 联系电话  
165 - "phone":"001001001001",  
166 - // 传真  
167 - "fax":"00100100",  
168 - // 邮件地址  
169 - "email":"XXX@qq.com",  
170 - // 网址  
171 - "url":"www.google.cn",  
172 - // 开户行  
173 - "bankName":"ICBC",  
174 - // 开户账号  
175 - "bankAccount":"001010001001" 410 + "code":200,
  411 + "message":"修改成功！"
176 } 412 }
177 413
178 ``` 414 ```