Open
/
open-api
18
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

wms供应商客户接口文档add

master
张耀宗 12 months ago
parent
4de13814c0
commit
5ed2132a28
10 changed files with 717 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 80
      wms/供应商/供应商列表.md
  2. 76
      wms/供应商/修改供应商.md
  3. 58
      wms/供应商/删除供应商.md
  4. 74
      wms/供应商/新增供应商.md
  5. 68
      wms/供应商/获取供应商详情.md
  6. 77
      wms/客户/修改客户.md
  7. 58
      wms/客户/删除客户.md
  8. 82
      wms/客户/客户列表.md
  9. 75
      wms/客户/新增客户.md
  10. 69
      wms/客户/获取客户详情.md

80
wms/供应商/供应商列表.md
View File

@ -0,0 +1,80 @@
### 供应商列表
此接口用于查询WMS中的供应商
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/GetWmsSupplierList
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
__请求示例：__
```
{
"data":{
"profile": "测试",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"records": [
{
"key": "943c1f4d0f164cddb74ad60be33c891d",
"status": 0,
"country": null,
"region": null,
"code": "GYS001",
"name": "供应商001",
"oaId": null,
"address": "1002",
"contact": "liu",
"phone": "156"
},
{
"key": "eb335cea0e894623859a68976a80342f",
"status": 0,
"country": null,
"region": null,
"code": "LM001",
"name": "螺帽",
"oaId": null,
"address": "",
"contact": "",
"phone": ""
},
]
}
}
```

76
wms/供应商/修改供应商.md
View File

@ -0,0 +1,76 @@
### 修改供应商
此接口用于修改WMS中的供应商
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/UpdateWmsSupplier
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| key | string | 是 | |
| code | string | 是 | 供应商编码 |
| name | string | 是 | 供应商名称 |
| status | string | 是 | 状态是否开启 |
| country | string | 否 | 国家 |
| region | string | 否 | 省市 |
__请求示例：__
```
{
"data":{
"profile": "测试",
"key":"d2d0916d46cc497e83e69ea9e307a92c",
"code":"wndSupplier",
"name":"天天好集团aaa",
"status": 0,
"country": "china",
"region":"SH",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"key": "d2d0916d46cc497e83e69ea9e307a92c",
"status": 0,
"country": "china",
"region": "SH",
"code": "wndSupplier",
"name": "天天好集团aaa",
"oaId": "",
"address": "",
"contact": "",
"phone": ""
}
}
```

58
wms/供应商/删除供应商.md
View File

@ -0,0 +1,58 @@
### 删除供应商
此接口用于删除WMS中的供应商
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/DeleteWmsSupplier
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| key | string | 是 | 列表记录key |
| code | string | 否 | 编码 |
__请求示例：__
```
{
"data":{
"profile": "测试",
"key": "",
"code": "",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
}
}
```

74
wms/供应商/新增供应商.md
View File

@ -0,0 +1,74 @@
### 新增供应商
此接口用于新增WMS中的供应商
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/AddWmsSupplier
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| code | string | 是 | 供应商编码 |
| name | string | 是 | 供应商名称 |
| status | string | 是 | 状态是否开启 |
| country | string | 否 | 国家 |
| region | string | 否 | 省市 |
__请求示例：__
```
{
"data":{
"profile": "测试",
"code":"wndSupplier",
"name":"天天好集团",
"status": 0,
"country": "china",
"region":"beijing",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"key": "d2d0916d46cc497e83e69ea9e307a92c",
"status": 0,
"country": "china",
"region": "beijing",
"code": "wndSupplier",
"name": "天天好集团",
"oaId": "",
"address": "",
"contact": "",
"phone": ""
}
}
```

68
wms/供应商/获取供应商详情.md
View File

@ -0,0 +1,68 @@
### 供应商详情 单条
此接口用于查询WMS中的供应商详情
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/GetWmsSupplierDetail
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区|
| key | string | 否 | |
| code | string | 否 | 编码 |
__请求示例：__
```
{
"data":{
"profile": "测试",
"key" : "",
"code": "GYS001",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"key": "943c1f4d0f164cddb74ad60be33c891d",
"status": 0,
"country": null,
"region": null,
"code": "GYS001",
"name": "供应商001",
"oaId": null,
"address": "1002",
"contact": "liu",
"phone": "156"
}
}
```

77
wms/客户/修改客户.md
View File

@ -0,0 +1,77 @@
### 修改客户
此接口用于修改WMS中的客户
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/UpdateWmsCustomer
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| code | String | 是 | 客户编码|
| name | String | 是 | 客户名称|
| key | String | 是| |
| country | String | 否 | 国家|
| region | String | 是 | 省市|
| status | int | 是 | 状态 1：启用 0：不启用|
__请求示例：__
```
{
"data":{
"profile":"测试",
"code":"wnC1",
"name":"屋漏",
"country":"china",
"region":"shanghai",
"status":0,
"key":"45960622d4a54c69b2e26a840056ff48"
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"oa_id": "",
"code": "wnC1",
"name": "屋漏",
"status": "0",
"country": "china",
"region": "shanghai",
"interior": 0,
"created": "2023-12-06 09:12:43.230",
"updated": "2023-12-06 09:16:52.252",
"key": "45960622d4a54c69b2e26a840056ff48",
"flag": 1
}
}
```

58
wms/客户/删除客户.md
View File

@ -0,0 +1,58 @@
### 删除客户
此接口用于删除WMS中的客户
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/DeleteWmsCustomer
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| key | string | 是 | |
| code | string | 否(优先按key删除) | |
__请求示例：__
```
{
"data":{
"profile": "测试",
"key": "2fadc517f26446069930ecb8a3f59356",
"code" : "code001"
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
}
}
```

82
wms/客户/客户列表.md
View File

@ -0,0 +1,82 @@
### 客户列表
此接口用于查询WMS中的客户
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/GetWmsCustomerList
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
__请求示例：__
```
{
"data":{
"profile": "测试",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"records": [
{
"oa_id": null,
"code": "code002",
"name": "客户002",
"status": "",
"country": null,
"region": null,
"interior": 0,
"created": "2022-09-30 12:48:55.211",
"updated": "2022-09-30 12:48:55.211",
"key": "4f3fbb290d0e4007817edf5e3bac25f2",
"flag": 1
},
{
"oa_id": null,
"code": "code004",
"name": "客户004",
"status": "",
"country": null,
"region": null,
"interior": 0,
"created": "2022-09-30 12:53:16.581",
"updated": "2022-09-30 12:53:16.581",
"key": "e0ef13b856d14a759c5889a20f69e8c7",
"flag": 1
},
]
}
}
```

75
wms/客户/新增客户.md
View File

@ -0,0 +1,75 @@
### 新增客户
此接口用于新增WMS中的客户
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/AddWmsCustomer
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| code | String | 是 | 客户编码|
| name | String | 是 | 客户名称|
| country | String | 否 | 国家|
| region | String | 是 | 省市|
| status | int | 是 | 状态 1：启用 0：不启用|
__请求示例：__
```
{
"data":{
"profile":"测试",
"code":"wnC1",
"name":"屋漏",
"country":"china",
"region":"beijing",
"status":0,
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"oa_id": null,
"code": "wnC1",
"name": "屋漏",
"status": "0",
"country": "china",
"region": "beijing",
"interior": 0,
"created": "2023-12-06 09:12:43.230",
"updated": "2023-12-06 09:12:43.230",
"key": "45960622d4a54c69b2e26a840056ff48",
"flag": 1
}
}
```

69
wms/客户/获取客户详情.md
View File

@ -0,0 +1,69 @@
### 获取客户详情
此接口用于查询WMS中的客户详情
此接口需要认证，详情请查看《认证方式》。
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/GetWmsCustomerDetail
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| code | string | | |
| key | string | | |
__请求示例：__
```
{
"data":{
"profile":"测试",
"code":"wnC1",
"key": "",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态，ok：成功，error：错误，exception：异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"oa_id": "",