# Smart WMS4.0 OpenAPI
**Repository Path**: xiaosloth/Smart-WMS4.0
## Basic Information
- **Project Name**: Smart WMS4.0 OpenAPI
- **Description**: 小蜜蜂Smart WMS4.0 OpenAPI接口文档
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 8
- **Created**: 2022-11-10
- **Last Updated**: 2022-11-10
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Smart WMS4.0第三方接口文档
------
- [Smart WMS4.0第三方接口文档](#smart-wms40第三方接口文档)
- [接口简介](#接口简介)
- [接口说明](#接口说明)
- [接口凭证](#接口凭证)
- [获取登陆凭证接口](#获取登陆凭证接口)
- [基础信息接口](#基础信息接口)
- [货主信息](#货主信息)
- [新增货主基础信息](#新增货主基础信息)
- [修改货主基础信息](#修改货主基础信息)
- [根据货主编码取得货主基础信息](#根据货主编码取得货主基础信息)
- [根据条件获取货主信息列表（分页）](#根据条件获取货主信息列表（分页）)
- [供应商信息](#供应商信息)
- [新增供应商信息](#新增供应商信息)
- [修改供应商信息](#修改供应商信息)
- [取得供应商信息](#取得供应商信息)
- [获取所有供应商信息](#获取所有供应商信息)
- [货主的供应商列表](#货主的供应商列表)
- [客户信息](#客户信息)
- [新增客户信息](#新增客户信息)
- [修改客户信息](#修改客户信息)
- [根据条件获取客户信息列表（分页）](#根据条件获取客户信息列表（分页）)
- [根据客户编码取得客户信息](#根据客户编码取得客户信息)
- [货物类别信息](#货物类别信息)
- [新增货物类别](#新增货物类别)
- [修改货物类别](#修改货物类别)
- [取得一个货物类别的所有子类](#取得一个货物类别的所有子类)
- [货物类别列表](#货物类别列表)
- [根据货物类别名称查询类别信息](#根据货物类别名称查询类别信息)
- [货物单位信息](#货物单位信息)
- [新增货物单位](#新增货物单位)
- [所有货物单位列表](#所有货物单位列表)
- [货主的货物单位列表](#货主的货物单位列表)
- [货物信息](#货物信息)
- [新增货物信息](#新增货物信息)
- [修改货物信息](#修改货物信息)
- [根据条件取得货物信息](#根据条件取得货物信息)
- [根据货主编码获取货物信息列表（分页）](#根据货主编码获取货物信息列表（分页）)
- [仓库信息](#仓库信息)
- [根据条件获取仓库信息](#根据条件获取仓库信息)
- [根据仓库编码取得仓库信息](#根据仓库编码取得仓库信息)
- [库区信息](#库区信息)
- [新增库区信息](#新增库区信息)
- [根据仓库编码、库区名称取得库区信息](#根据仓库编码、库区名称取得库区信息)
- [根据仓库编号获取库区信息列表（分页）](#根据仓库编号获取库区信息列表（分页）)
- [根据条件获取库区信息列表（分页）](#根据条件获取库区信息列表（分页）)
- [库位信息](#库位信息)
- [新增库位信息](#新增库位信息)
- [修改库位信息](#修改库位信息)
- [根据库位编码取得库位信息](#根据库位编码取得库位信息)
- [根据条件获取库位信息列表（分页）](#根据条件获取库位信息列表（分页）)
- [工作区信息](#工作区信息)
- [新增工作区信息](#新增工作区信息)
- [根据条件获取工作区信息列表（分页）](#根据条件获取工作区信息列表（分页）)
- [入库接口](#入库接口)
- [新增入库订单](#新增入库订单)
- [快速入库](#快速入库)
- [根据条件获取入库订单信息](#根据条件获取入库订单信息)
- [根据条件获取入库订单的状态](#根据条件获取入库订单的状态)
- [根据入库订单Id获取入库订单明细](#根据入库订单id获取入库订单明细)
- [根据条件取消入库订单](#根据条件取消入库订单)
- [出库接口](#出库接口)
- [新增出库订单](#新增出库订单)
- [新增出库订单_Code](#新增出库订单_Code)
- [快速出库](#快速出库)
- [快速出库Code版](#快速出库_Code)
- [根据条件获取出库订单信息](#根据条件获取出库订单信息)
- [根据出库订单Id获取出库订单明细](#根据出库订单id获取出库订单明细)
- [根据条件取消出库订单](#根据条件取消出库订单)
- [根据条件取消快速出库订单](#根据条件取消快速出库订单)
- [根据条件取消快速出库确认订单](#根据条件取消快速出库确认订单)
- [库存接口](#库存接口)
- [货物库存](#货物库存)
- [货主条件查询库存](#货主条件查询库存)
- [组合条件查询库存](#组合条件查询库存)
## 接口简介
本文档为Smart WMS4.0第三方开放接口文档，操作流程为：
1. 联系实施人员获取WMS API账号（一个三方系统，对应一个账号）；
2. 获取访问接口的令牌token（**有效期为24小时，失效后需要获取！**）；
3. 调用WMS提供的接口；
**请使用WMS API账号获取对应的token再调用其他接口！！！**
- **接口URL地址**
Smart WMS4.0系统的访问地址假设为：192.168.1.120，则对应的开放接口地址为：
http://192.168.1.120/wmsservice/openapi/
- **调用接口方式**
接口URL地址 + 各接口请求 URL，如获取token接口为：
http://192.168.1.120/wmsservice/openapi/auth/token
## 接口说明
所有接口支持RESTful的方式访问
Get请求参数为 url拼接，例：http://192.168.1.120/wmsservice/openapi?data1=value1&data2=value2
其余接口请求参数都为Json字符串
所有接口返回结果都为json字符串。
**1. 分配的WMS API账号信息**
系统实施人员提供以下WMS API账号相关信息：
|参数名|说明|
|:----- |----- |
|tpsCode |第三方系统代码 |
|password |密码，获取token使用 |
|key |密钥，所有接口MD5必填 |
**2. Header设置（所有接口Header中必须设置）**
|参数名|说明|
|:----- |----- |
|token |token，获取token时可为空，其他所有接口均必填 |
|sign |必填 签名 |
|nonce |必填 随机字符串（string 长度最大16，字母或数字组合） |
**3. 签名算法**
将nonce（随机字符串）、data（请求参数）、key（分配的签名key值）通过url参数方式拼接，然后进行MD5加密。即：nonce=随机字符串&data=参数&key=key值
例：
nonce为：abcdefgh12345678
参数为：{"contno":"MSCU8888888","contsize":"40","conttype":"GP"}
key为：kjshuy9876r65e6vjpouo8fyu99
则需要进行MD5的字符串数据为：
nonce=abcdefgh12345678&data={"contno":"MSCU8888888","contsize":"40","conttype":"GP"}&key=kjshuy9876r65e6vjpouo8fyu99
即：
MD5(nonce=abcdefgh12345678&data={"contno":"MSCU8888888","contsize":"40","conttype":"GP"}&key=kjshuy9876r65e6vjpouo8fyu99)
**4. 返回对象说明**
|属性名|类型|说明|
|:----- |:----- |----- |
|success |boolean |操作是否成功, true:成功, false:失败 |
|errCode |int |错误代码，0：成功; 其它值：失败，对应msg为错误信息 |
|msg |string |成功/失败信息 |
|map |Map |其它返回值，以key=value形式存储 |
**返回示例**
```
{
"success": true,
"errCode": 0,
"msg": "新增用户成功",
"map": {"userId": 1, "type": 1}
}
```
# 接口凭证
## 获取登陆凭证接口
**简要描述：** 获取登陆凭证
**请求 URL：** `/auth/token`
**请求方式：** POST
**需要认证：** 否
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `tpsCode` | 是 | `String` | `账号` |
| `password` | 是 | `String` | `密码` |
**返回示例**
- 调用成功示例
```java
{
"errCode": 0,
"message": "获取token成功",
"success":true,
"map": {
"token": "xxxxxxxx.xxxxxxx.xxxxxxx"
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "账号或密码不正确"
}
```
# 基础信息接口
## 货主信息
### 新增货主基础信息
**简要描述：** 新增货主基础信息
**请求 URL：** `/shippers/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `contactEmail` | 否 | `String` | `联系人邮箱` |
| `shipperCode` | 是 | `String` | `货主编码` |
| `shipperName` | 是 | `String` | `货主名称` |
| `contactName` | 是 | `String` | `联系人名称` |
| `contactPhone` | 是 | `String` | `联系电话` |
| `provinceId` | 是 | `String` | `省Id` |
| `provinceName` | 是 | `String` | `省名称` |
| `cityId` | 是 | `String` | `市Id` |
| `cityName` | 是 | `String` | `市名称` |
| `areaId` | 是 | `String` | `区Id` |
| `areaName` | 是 | `String` | `区名称` |
| `streetId` | 否 | `String` | `街道Id` |
| `streetName` | 否 | `String` | `街道名称` |
| `detailAddress` | 否 | `String` | `详细地址` |
| `defaultCarrierId` | 否 | `String` | `默认承运商Id` |
| `shipperTagName` | 否 | `String` | `货主类别名称 值为：新货主，旧货主等（类似标签）` |
| `isDefault` | 是 | `String` | `是否默认货主` 1是；0否 可以都选非默认|
| `remarks` | 否 | `String` | `备注` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "货主基础信息保存成功!",
"map": {
"shipperId": "4028368170de6d430170de7e4af3000b"
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 修改货主基础信息
**简要描述：** 修改货主基础信息
**请求 URL：** `/shippers/v4`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|`shipperId`|是|`String`|`货主Id`|
|`contactEmail` | 否 | `String` | `联系人邮箱` |
|`shipperCode` | 是 | `String` | `货主编码` |
|`shipperName` | 是 | `String` | `货主名称` |
|`contactName` | 是 | `String` | `联系人名称` |
|`contactPhone` | 是 | `String` | `联系电话` |
|`provinceId` | 是 | `String` | `省Id` |
|`provinceName` | 是 | `String` | `省名称` |
|`cityId` | 是 | `String` | `市Id` |
|`cityName` | 是 | `String` | `市名称` |
|`areaId` | 是 | `String` | `区Id` |
|`areaName` | 是 | `String` | `区名称` |
|`streetId` | 否 | `String` | `街道Id` |
|`streetName` | 否 | `String` | `街道名称` |
|`detailAddress` | 否 | `String` | `详细地址` |
|`defaultCarrierId` | 否 | `String` | `默认承运商Id` |
|`shipperTagName` | 否 | `String` | `货主类别名称` |
|`isDefault` | 是 | `String` | `是否默认货主` 1是；0否 |
|`remarks` | 否 | `String` | `备注` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "货主基础信息更新成功!",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 根据货主编码取得货主基础信息
**简要描述：** 根据货主编码取得货主基础信息
**请求 URL：** `/shippers/v4/info`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|`shipperCode` | 是 | `String` | `货主编码` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"shipper": {
"shipperId": "4028368170de6d430170de7e4af3000b",
"shipperStatus": 1,
"contactEmail": "3444@te.dc",
"shipperErpConfigStatus": 0,
"contactName": "官网发文",
"shipperName": "Alec Jast",
"cityId": "1404",
"provinceId": "14",
"shipperCode": "sc455",
"defaultCarrierId": "4028368170c4cc410170c5019a490030",
"streetName": null,
"isDefault": 1,
"areaId": "140423",
"shipperLocationStatus": 0,
"cityName": "长治市",
"shipperTagName": null,
"areaName": "襄垣县",
"shipperConfigStatus": 0,
"detailAddress": "jjjjy",
"shipperTag": 4,
"provinceName": "山西省",
"contactPhone": "15444444444",
"remarks": "飞飞飞",
"streetId": "140423100"
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 根据条件获取货主信息列表（分页）
**简要描述：** 根据条件获取货主信息列表（分页），查询条件包括货主名称、货主编码。
**请求 URL：** `/shippers/v4/page`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|`limit`|是|`String`|`每页记录数`|
|`page`|是|`String`|`第几页`|
|`shipperName` | 否 | `String` | `货主名称` |
|`shipperCode` | 否 | `String` | `货主编码` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"page": {
"page": 1,
"totalCount": 1,
"total": 1,
"rows": [
{
"shipperId": "4028368170de6d430170de7e4af3000b",
"shipperCode": "sc455",
"shipperName": "Alec Jast",
"shipperStatus": 1,
"contactPhone": "15444444444",
"contactEmail": "3444@te.dc",
"contactName": "官网发文",
"provinceId": "14",
"provinceName": "山西省",
"cityId": "1404",
"cityName": "长治市",
"areaId": "140423",
"areaName": "襄垣县",
"streetId": "140423100",
"streetName": null,
"detailAddress": "jjjjy",
"remarks": "飞飞飞",
"shipperTag": 4,
"shipperTagName": null,
"defaultCarrierId": "4028368170c4cc410170c5019a490030",
"createorId": "erpId",
"createName": "ERP用户",
"createTime": 1584280784000,
"updaterId": "erpId",
"updateName": "ERP用户",
"updateTime": 1584280904000,
"shipperConfigStatus": 0,
"shipperLocationStatus": 0,
"shipperErpConfigStatus": 0,
"isDefault": 1
}
]
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 供应商信息
### 新增供应商信息
**简要描述：** 新增供应商信息
**请求 URL：** `/suppliers/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `supplierCode` | 是 | `String` | `供应商编码` |
| `supplierName` | 是 | `String` | `供应商名称` |
| `shipperId` | 是 | `String` | `货主Id` |
| `isDefault` | 是 | `String` | `是否默认供应商，1是；0否` |
| `provinceId` | 是 | `String` | `省id` |
| `provinceName` | 是 | `String` | `省名称` |
| `cityId` | 是 | `String` | `市id` |
| `cityName` | 是 | `String` | `市名称` |
| `areaId` | 是 | `String` | `区id` |
| `areaName` | 是 | `String` | `区名称` |
| `streetId` | 否 | `String` | `街道id` |
| `streetName` | 否 | `String` | `街道名称` |
| `address` | 否 | `String` | `详细地址` |
| `postalCode` | 否 | `String` | `邮编` |
| `respectiveRegion` | 否 | `String` | `所属区域` |
| `contactName` | 是 | `String` | `联系人名称` |
| `contactMobilePhone` | 否 | `String` | `联系人手机` |
| `contactTelephone` | 否 | `String` | `联系人电话` |
| `contactDepartment` | 否 | `String` | `联系人部门` |
| `carrierId` | 否 | `String` | `指定承运商Id` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "供应商信息保存成功!",
"map": {
"supplierId": "4028368170d945e20170d95825a00001"
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 修改供应商信息
**简要描述：** 修改供应商信息
**请求 URL：** `/suppliers/v4`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `supplierId` | 是 | `String` | `供应商Id` |
| `supplierCode` | 是 | `String` | `供应商编码` |
| `supplierName` | 是 | `String` | `供应商名称` |
| `shipperId` | 是 | `String` | `货主Id` |
| `isDefault` | 是 | `String` | `是否默认供应商，1是；0否` |
| `provinceId` | 是 | `String` | `省id` |
| `provinceName` | 是 | `String` | `省名称` |
| `cityId` | 是 | `String` | `市id` |
| `cityName` | 是 | `String` | `市名称` |
| `areaId` | 是 | `String` | `区id` |
| `areaName` | 是 | `String` | `区名称` |
| `streetId` | 否 | `String` | `街道id` |
| `streetName` | 否 | `String` | `街道名称` |
| `address` | 否 | `String` | `详细地址` |
| `postalCode` | 否 | `String` | `邮编` |
| `respectiveRegion` | 否 | `String` | `所属区域` |
| `contactName` | 是 | `String` | `联系人名称` |
| `contactMobilePhone` | 否 | `String` | `联系人手机` |
| `contactTelephone` | 否 | `String` | `联系人电话` |
| `contactDepartment` | 否 | `String` | `联系人部门` |
| `carrierId` | 否 | `String` | `指定承运商Id` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "供应商信息更新成功!",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 取得供应商信息
**简要描述：** 根据供应商编码取得供应商信息
**请求 URL：** `/suppliers/v4/info`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `supplierCode` | 是 | `String` | `供应商编码` |
| `shipperId` | 是 | `String` | `货主ID` |
**返回示例**
- 调用成功示例
```JSON
{
"success": false,
"errCode": 0,
"msg": "请求成功",
"map": {
"supplier": {
"supplierId": "4028368170c4cc410170c4fa52a6002e",
"supplierCode": "gys001",
"supplierName": "漂亮",
"shipperId": "4028368170c4cc410170c4f1ac3e0024",
"provinceId": "13",
"provinceName": "河北省",
"cityId": "1302",
"cityName": "唐山市",
"areaId": "130203",
"areaName": "路北区",
"streetId": "",
"streetName": "",
"address": "5454",
"contactName": "规范",
"contactMobilePhone": "15645654545",
"contactTelephone": "",
"supplierAliases": "",
"carrierId": "",
"createorId": "402881f868ff4bc301690d9929210098",
"createName": "超级管理员",
"createTime": 1583852704000,
"updaterId": "402881f868ff4bc301690d9929210098",
"updateName": "超级管理员",
"updateTime": 1583915170000,
"respectiveRegion": "",
"postalCode": "",
"contactDepartment": "",
"isDefault": 0,
"supplierCodeAndShipperId": null
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 获取所有供应商信息
**简要描述：** 根据供应商编码、名称等条件取得供应商信息，分页返回结果
**请求 URL：** `/suppliers/v4/page`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `limit` | 是 | `String` | `每页记录数` |
| `page` | 是 | `String` | `页数` |
| `shipperName` | 否 | `String` | `货主名称` |
| `supplierCode` | 否 | `String` | `供应商编码` |
| `supplierName` | 否 | `String` | `供应商名称` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"page": {
"page": 1,
"totalCount": 3,
"total": 3,
"rows": [
{
"supplierName": "FrozenJosianne Bashirian",
"respectiveRegion": "所属区域",
"contactDepartment": "大部分部门",
"supplierId": "4028368170d945e20170d95825a00001",
"address": "三个",
"contactTelephone": "11455455654",
"contactName": "好饿",
"postalCode": "666555",
"updateTime": 1584194575000,
"shipperName": "刘三姐",
"supplierCode": "open49485717",
"contactMobilePhone": "15645645654",
"updateName": "ERP用户",
"shipperCode": "lsj",
"streetName": "东华门街道办事处",
"isDefault": 0,
"cityName": "市辖区",
"areaName": "东城区",
"createTime": 1584194398000,
"provinceName": "北京市",
"supplierAliases": "",
"createName": "ERP用户"
}
]
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 货主的供应商列表
**简要描述：** 根据货主查询供应商列表
**请求 URL：** `/suppliers/v4/list/by/shipper`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一个|
| `shipperId` | 否 | `String` | `货主Id` |
| `shipperCode` | 否 | `String` | `货主编码` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"supplierList": [
{
"supplierId": "4028368170c4cc410170c4fa52a6002e",
"supplierCode": "gys001",
"supplierName": "漂亮",
"shipperId": "4028368170c4cc410170c4f1ac3e0024",
"provinceId": "13",
"provinceName": "河北省",
"cityId": "1302",
"cityName": "唐山市",
"areaId": "130203",
"areaName": "路北区",
"streetId": "",
"streetName": "",
"address": "5454",
"contactName": "规范",
"contactMobilePhone": "15645654545",
"contactTelephone": "",
"supplierAliases": "",
"carrierId": "",
"createorId": "402881f868ff4bc301690d9929210098",
"createName": "超级管理员",
"createTime": 1583852704000,
"updaterId": "402881f868ff4bc301690d9929210098",
"updateName": "超级管理员",
"updateTime": 1583915170000,
"respectiveRegion": "",
"postalCode": "",
"contactDepartment": "",
"isDefault": 0,
"supplierCodeAndShipperId": null
},
{
"supplierId": "4028368170d900d00170d919ea340005",
"supplierCode": "open23386930",
"supplierName": "GraniteArdith Champlin IV",
"shipperId": "4028368170c4cc410170c4f1ac3e0024",
"provinceId": "11",
"provinceName": "北京市",
"cityId": "1101",
"cityName": "市辖区",
"areaId": "110101",
"areaName": "东城区",
"streetId": "110101001",
"streetName": "东华门街道办事处",
"address": "三个",
"contactName": "好饿t",
"contactMobilePhone": "15645645654",
"contactTelephone": "11455455654",
"supplierAliases": "",
"carrierId": "4028805a70c734740170c7a699370063",
"createorId": "erpId",
"createName": "ERP用户",
"createTime": 1584190319000,
"updaterId": "402881f868ff4bc301690d9929210098",
"updateName": "超级管理员",
"updateTime": 1584191153000,
"respectiveRegion": "所属区域",
"postalCode": "666555",
"contactDepartment": "大部分部门",
"isDefault": 0,
"supplierCodeAndShipperId": null
}
]
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 客户信息
### 新增客户信息
**简要描述：** 新增客户信息
**请求 URL：** `/customers/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `customerCode` | 是 | `string` | 客户编码 |
| `customerName` | 是 | `string` | 客户名称 |
| `contactName` | 是 | `string` | 联系人 |
| `contactMobilePhone` | 否 | `string` | 联系人手机 |
| `provinceId` | 是 | `string` | 省id |
| `provinceName` | 是 | `string` | 省名称 |
| `cityId` | 是 | `string` | 市id |
| `cityName` | 是 | `string` | 市名称 |
| `areaId` | 是 | `string` | 区id |
| `areaName` | 是 | `string` | 区名称 |
| `streetId` | 否 | `string` | 街道Id |
| `streetName` | 否 | `string` |街道名称 |
| `shipperId` | 是 | `string` | 货主Id |
| `address` | 否 | `string` | 详细地址 |
| `customerWarehouse` | 是 | `int` | 是否仓库(0:否 1：是)(是否仓库、是否门店、是否终端收货人 不能同时为0) |
| `customerStore` | 是 | `int` | 是否门店 (0:否 1：是) |
| `terminalConsignee` | 是 | `int` | 是否终端收货人(0:否 1:是) |
| `respectiveRegion` | 否 | `string` | 所属区域 |
| `postalCode` | 否 | `string` | 邮编 |
| `contactDepartment` | 否 | `string` | 联系人部门 |
| `contactTelephone` | 否 | `string` | 联系人电话 |
| `customerAliases` | 否 | `string` | 客户别名 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "客户信息保存成功!",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 修改客户信息
**简要描述：** 修改客户信息
**请求 URL：** `/customers/v4`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `customerId` | 是 | `string` | 客户Id |
| `customerCode` | 是 | `string` | 客户编码 |
| `customerName` | 是 | `string` | 客户名称 |
| `contactName` | 是 | `string` | 联系人 |
| `contactMobilePhone` | 否 | `string` | 联系人手机 |
| `provinceId` | 是 | `string` | 省id |
| `provinceName` | 是 | `string` | 省名称 |
| `cityId` | 是 | `string` | 市id |
| `cityName` | 是 | `string` | 市名称 |
| `areaId` | 是 | `string` | 区id |
| `areaName` | 是 | `string` | 区名称 |
| `streetId` | 否 | `string` | 街道Id |
| `streetName` | 否 | `string` |街道名称 |
| `shipperId` | 是 | `string` | 货主Id |
| `address` | 否 | `string` | 详细地址 |
| `customerWarehouse` | 是 | `int` | 是否仓库(0:否 1：是)(是否仓库、是否门店、是否终端收货人 不能同时为0) |
| `customerStore` | 是 | `int` | 是否门店 (0:否 1：是) |
| `terminalConsignee` | 是 | `int` | 是否终端收货人(0:否 1:是) |
| `respectiveRegion` | 否 | `string` | 所属区域 |
| `postalCode` | 否 | `string` | 邮编 |
| `contactDepartment` | 否 | `string` | 联系人部门 |
| `contactTelephone` | 否 | `string` | 联系人电话 |
| `customerAliases` | 否 | `string` | 客户别名 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "客户信息更新成功!",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 根据条件获取客户信息列表（分页）
**简要描述：** 根据条件获取客户信息列表（分页）
**请求 URL：** `/customers/v4/page`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `customerName` | 否 | `string` | 客户名称 |
| `customerCode` | 否 | `string` | 客户编码 |
| `page` | 是 | `string` | 第几页 |
| `limit` | 是 | `string` | 显示条数 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"customerPage": {
"page": 1,
"totalCount": 1,
"total": 1,
"rows": [
{
"customerId": "402881966e1fc608016e1fe158870011",//客户Id
"respectiveRegion": "",//所属区域
"contactDepartment": "",//联系人部门
"address": "",//详细地址
"contactTelephone": "",//联系人电话
"contactName": "121212112",//联系人名称
"postalCode": "",//邮编
"customerCode": "201910311134",//客户编码
"shipperName": "张三",//货主名称
"customerWarehouse": 0,//是否仓库 0否 1是
"contactMobilePhone": "",//联系人手机
"customerName": "枫溪",//客户名称
"terminalConsignee": 0,//是否终端收货人 0否 1是
"shipperCode": "20190916",//货主编码
"streetName": "",//街道
"customerStore": 0,//是否门店 0否 1是
"cityName": "市辖区",//城市名称
"areaName": "东城区",//区
"provinceName": "北京市",//省
"customerAliases": "",//客户别名
}
]
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 根据客户编码取得客户信息
**简要描述：** 根据客户编码取得客户信息
**请求 URL：** `/customers/v4/info`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `customerCode` | 是 | `string` | 客户编码 |
| `shipperId` | 是 | `string` |货主Id |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"customerInfo": {
"respectiveRegion": "",//所属区域
"contactDepartment": "",//联系人部门
"address": "",//详细地址
"contactTelephone": "",//联系人电话
"contactName": "121212112",//联系人名称
"postalCode": "",//邮编
"customerCode": "201910311134",//客户编码
"shipperName": "张三",//货主名称
"customerWarehouse": 0,//是否仓库 0否 1是
"contactMobilePhone": "",//联系人手机
"customerName": "枫溪",//客户名称
"terminalConsignee": 0,//是否终端收货人 0否 1是
"shipperCode": "20190916",//货主编码
"streetName": "",//街道
"customerStore": 0,//是否门店 0否 1是
"cityName": "市辖区",//城市名称
"areaName": "东城区",//区
"provinceName": "北京市",//省
"customerAliases": ""//客户别名
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
## 货物类别信息
### 新增货物类别
**简要描述：** 新增货物类别
**请求 URL：** `/goodsCategorys/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `goodsCategoryName` | 是 | `string` | 类别名称 |
| `parentId` | 是 | `string` | 父类Id(为0时代表主类别) |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "货物类别信息保存成功!",
"map": {"goodsCategoryId":"402881956c4b7361016c4b8403d9001f"}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 修改货物类别
**简要描述：** 修改货物类别
**请求 URL：** `/goodsCategorys/v4`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `goodsCategoryId` | 是 | `string` | 类别Id |
| `goodsCategoryName` | 是 | `string` | 类别名称 |
| `parentId` | 是 | `string` | 父类Id(为0时代表主类别) |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "客户信息更新成功!",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 取得一个货物类别的所有子类
**简要描述：** 取得一个货物类别的所有子类
**请求 URL：** `/goodsCategorys/v4/childs`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `goodsCategoryId` | 是 | `string` | 类别Id |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"categoryTreeChild": [
{
"id": "402881956c4b7361016c4b8403d9001f",//类别Id
"pId": "402881956c4b7361016c4b83e29f001e",//类别父Id
"name": "水果",//类别名称
"isParent": 0,//是否是父目录
"children": [] //子类别
}
]
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 货物类别列表
**简要描述：** 根据货主Id、货主编码查询货物类别列表
**请求 URL：** `/goodsCategorys/v4/shipper`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一个|
| `shipperId` | 否 | `String` | `货主Id` |
| `shipperCode` | 否 | `String` | `货主编码` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"goodsCategory": [
{
"goodsCategoryId": "4028368170c4cc410170c4e848ce0022",
"goodsCategoryName": "化妆品",
"parentId": "0",
"goodsCategoryStatus": 1
}
]
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据货物类别名称查询类别信息
**简要描述：** 根据货物类别名称查询类别信息
**请求 URL：** `/goodsCategorys/v4/by/name`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `goodsCategoryName` | 是 | `string` | 货物类别名称 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"category": {
"goodsCategoryId": "402881917129d124017129d8ed9b0000",//类别Id
"goodsCategoryName": "默认",//类别名称
"goodsCategoryStatus": 1,//类别状态(0禁用,1启用)
"parentId": "0" //类别父id
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
## 货物单位信息
### 新增货物单位
**简要描述：** 新增货物单位
**请求 URL：** `/goodsUnits/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `goodsUnitName` | 是 | `string` | 货物单位名称 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "货物单位保存成功！",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 所有货物单位列表
**简要描述：** 所有货物单位列表
**请求 URL：** `/goodsUnits/v4/list`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
无
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"goodsUnitList": [
{
"goodsUnitId": "402881956c605fc5016c60844e3901a8",//货物单位Id
"goodsUnitName": "斤",//货物单位名称
"goodsUnitStatus": 1//货物单位状态
}
]
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 货主的货物单位列表
**简要描述：** 根据货主查询货物单位列表，支持shipperId或shipperCode
**请求 URL：** `/goodsUnits/v4/shipper`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一个|
| `shipperId` | 否 | `String` | `货主Id` |
| `shipperCode` | 否 | `String` | `货主编码` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"goodsUnit": [
{
"goodsUnitId": "4028368170c4cc410170c502ccb80033",
"goodsUnitName": "盒",
"goodsUnitStatus": 1,
"createorId": null,
"createName": null,
"createTime": null,
"updaterId": null,
"updateName": null,
"updateTime": null
},
{
"goodsUnitId": "4028368170c8a6f20170c8af77380001",
"goodsUnitName": "具",
"goodsUnitStatus": 1,
"createorId": null,
"createName": null,
"createTime": null,
"updaterId": null,
"updateName": null,
"updateTime": null
}
]
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 货物信息
### 新增货物信息
**简要描述：** 新增货物信息
**请求 URL：** `/goods/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `shipperId` | 是 | `string` | 货主Id |
| `goodsCategoryId` | 是 | `string` | 品类Id |
| `goodsCode` | 是 | `string` | 货物编码 |
| `goodsName` | 是 | `string` | 货物名称 |
| `goodBarcode` | 是 | `string` | 货物条码 |
| `goodsUnitId` | 否 | `string` | 货物单位Id 直接传货物单位名称，接口自动判断是否存在此名称，如不存在自动添加到货物单位中 |
| `goodsUnitName` | 是 | `string` | 货物单位名称 |
| `specificationType` | 否 | `string` | 规格型号 |
| `itemLength` | 否 | `int` | 单品长 |
| `itemWidth` | 否 | `int` | 单品宽 |
| `itemHigh` | 否 | `int` | 单品高 |
| `goodsVolume` | 否 | `int` | 单品体积 |
| `grossWeight` | 否 | `int` | 单品毛重(kg) |
| `collectBatchNo` | 否 | `int` | 是否采集批次号 0:否 1:是 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "货物信息保存成功!",
"map": {"goodsId":"4028368170c8a6f20170c8af77380001"}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 修改货物信息
**简要描述：** 修改货物信息
**请求 URL：** `/goods/v4`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `goodsId` | 是 | `string` | 货物Id |
| `shipperId` | 是 | `string` | 货主Id |
| `goodsCategoryId` | 是 | `string` | 品类Id |
| `goodsCode` | 是 | `string` | 货物编码 |
| `goodsName` | 是 | `string` | 货物名称 |
| `goodBarcode` | 是 | `string` | 货物条码 |
| `goodsUnitId` | 否 | `string` | 货物单位Id |
| `goodsUnitName` | 是 | `string` | 货物单位名称 |
| `specificationType` | 否 | `string` | 规格型号 |
| `itemLength` | 否 | `int` | 单品长 |
| `itemWidth` | 否 | `int` | 单品宽 |
| `itemHigh` | 否 | `int` | 单品高 |
| `goodsVolume` | 否 | `int` | 单品体积 |
| `grossWeight` | 否 | `int` | 单品毛重(kg) |
| `collectBatchNo` | 否 | `int` | 是否采集批次号 0:否 1:是 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "货物信息更新成功!",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 根据条件取得货物信息
**简要描述：** 根据货物条码、货物编码、货主Id取得货物信息
**请求 URL：** `/goods/v4/info`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一个|
| `shipperId` | 否 | `String` | 货主Id |
| `goodsCode` | 否 | `string` | 货物编码 |
| `goodBarcode` | 否 | `string` | 货物条码 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"goods": {
"goodsUnitId": "4028368170c4cc410170c502ccb80033",
"goodsPackageStatus": null,
"shipperId": "4028368170c4cc410170c4f1ac3e0024",
"supplierId": "",
"goodsId": "4028368170c4cc410170c502ccba0035",
"goodsColor": "",
"combinedGoods": 1,
"pickingEfficiency": "",
"goodsBrand": "",
"goodsCategoryId": "4028368170c4cc410170c4e848ce0022",
"pickingRate": 1.0,
"goodBarcode": "mm",
"itemWidth": null,
"mnemonicCode": "",
"palletLimit": "",
"goodsName": "面膜",
"goodsUnitName": "盒",
"picturePath": "",
"shipperIdList": null,
"purchasingPrice": 11.0,
"goodstCode": "",
"goodsLocationStatus": null,
"salePrice": 33.0,
"costPrice": 22.0,
"goodsSize": "",
"specificationType": "",
"goodsVolume": null,
"itemLength": null,
"approvalNumber": "",
"multiBarCode": "",
"useStatus": 1,
"defaultCarrierId": "",
"grossWeight": null,
"netWeight": null,
"goodsStatus": 1,
"goodsCode": "hw001",
"goodsInfo": "面膜/mm/hw001",
"itemHigh": null
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
### 根据货主编码获取货物信息列表（分页）
**简要描述：** 根据货主编码获取货物信息列表（分页）
**请求 URL：** `/goods/v4/info/by/shipper`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `shipperCode` | 是 | `string` | 货主编码 |
| `page` | 是 | `int` | 第几页 |
| `limit` | 是 | `int` | 显示记录数 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"pageInfo": {
"total": 7,
"page": 1,
"totalCount": 1,
"rows": [
{
"goodsId": "02b7d2d89af94aa59fb83137100f2620",//货物Id
"shipperName": "尼古拉斯赵四",//货主名称
"goodsCategoryName": "食品",//货物类别名称
"goodsCode": "2019000019",//货物编码
"goodsName": "红富士",//货物名称
"goodsUnitName": "个",//单位名称
"goodBarcode": "2019000019",//货物条码
"purchasingPrice": 0.0,//采购价(元)
"costPrice": null,//成本价(元)
"salePrice": 0.0,//销售价(元)
"supplierId": "",//供应商id
"pickingRate": 1.0,//包装率
"mnemonicCode": "",//助记码
"specificationType": "",//规格
"goodstCode": "",//货物货号
"goodsColor": "",//颜色
"goodsSize": "",//货物尺码
"goodsBrand": "",//goodsBrand
"approvalNumber": "",//批准文号
"palletLimit": "",//托盘限额
"pickingEfficiency": "",//拣货效率
"multiBarCode": "",//多条码
"combinedGoods": 1,//组合货物(1:普通货物 2一级货物)
"picturePath": "",//图片
"itemLength": null,//单品长(m)
"itemWidth": null,//单品宽(m)
"itemHigh": null,//单品高(m)
"goodsVolume": 5.0,//单品体积
"grossWeight": 10.0,//单品毛重(kg)
"netWeight": null,//单品净重(kg)
"goodsStatus": 1,//货物状态
"goodsInfo": "红富士/2019000019/2019000019",//货物信息(品名/条码/编码)
"boxVolume": null,//整箱体积
"updaterId": "402881f868ff4bc301690d9929210098",//更新人Id
"updateName": "超级管理员",//更新人名称
"updateTime": 1581576385000,//更新时间
"shelfLife": 30,//保质期
"goodsCollectionPeriod": 1,//收货采集效期(0不采集 1采集)
"collectType": 1,//采集类型
"wareLife": null,//效期提前预警天数
"stockExpirationFreeze": 0,//库存过期冻结开关 0否 1是
"beyondRefuse": 1,//超过效期拒收 0否 1是
"autoCreateBatchNo": 1,//是否自动生成批次 0否 1是
"collectBatchNo": 0,//是否采集批次号 0否 1是
"goodsSN": 0,//是否采集收货SN 0否 1是
"deliverySN": 0,//发货采集SN 0否 1是
"createName": "超级管理员",//创建人名称
"createTime": 1567655168000,//创建时间
"goodsLocationStatus": null,//货物指定库位状态 0否 1是
"goodsPackageStatus": null,//货物多包装状态开关 0否 1是
"useStatus": null,//使用状态 0未使用 1已使用
"inventoryEffectWarn": 0//库存效期预警 0否 1是
}
]
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
## 仓库信息
### 根据条件获取仓库信息
**简要描述：** 根据条件获取仓库信息列表（分页）
**请求 URL：** `/wareHouses/v4/page`
**请求方式：** get
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `houseCode` | 否 | `String` | `仓库编码` |
| `houseName` | 是 | `String` | `仓库名称` |
| `page` | 是 | `int` | `页码` |
| `limit` | 是 | `int` | `单页最多显示数量` |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "操作成功",
"map": {
"wareHousePage": {
"total": 1,
"page": 1,
"totalCount": 1,
"rows": [
{
"houseId": "4028818f702a2ec401702a358ffe0001",
"address": "华苑公司",
"contactTelephone": "13693052400",
"houseStatus": 1,
"contactEmail": null,
"autoPushCarrier": 0,
"contactName": "wsp",
"maxStorageNum": null,
"cityId": "1201",
"provinceId": "12",
"houseName": "聚家云仓wms",
"orderRefreshRate": 0,
"streetName": "西青区开发区",
"isDefault": 0,
"areaId": "120111",
"cityName": "市辖区",
"areaName": "西青区",
"houseCode": "ck-017",
"stockInitial": 0,
"provinceName": "天津市",
"streetId": "120111450"
}
]
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
### 根据仓库编码取得仓库信息
**简要描述：** 根据仓库编码取得仓库信息
**请求 URL：** `/wareHouses/v4/houseCode`
**请求方式：** get
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `houseCode` | 否 | `String` | `仓库编码` |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "操作成功",
"map": {
"wareHouse": {
"houseId": "4028818f702a2ec401702a358ffe0001",
"address": "华苑公司",
"contactTelephone": "13693052400",
"houseStatus": 1,
"contactEmail": null,
"autoPushCarrier": 0,
"contactName": "wsp",
"maxStorageNum": null,
"cityId": "1201",
"provinceId": "12",
"houseName": "聚家云仓wms",
"orderRefreshRate": 0,
"streetName": "西青区开发区",
"isDefault": 0,
"areaId": "120111",
"cityName": "市辖区",
"areaName": "西青区",
"houseCode": "ck-017",
"stockInitial": 0,
"provinceName": "天津市",
"streetId": "120111450"
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
## 库区信息
### 新增库区信息
**简要描述：** 新增库区信息
**请求 URL：** `/storeAreas/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
- 请求参数示例
```java
{
"houseId": "402881916fb0f2b4016fb100bfed0001",
"storeAreaName": "1002002",
"storeAreaCategroy": 1,
"storeAreaType": 5,
"storehouseNum": 10,
"remarks": "备注"
}
```
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `houseId` | 是 | String | 仓库id |
| `storeAreaName` | 是 | String | 库区名称 |
| `storeAreaCategroy` | 是 | int | 库区类别 1:常温 2:冷藏 3:重型货 4:轻型货 5:贵重物品 |
| `storeAreaType` | 是 | String | 库区类型 1.存储区 2.拣货区 3.收货区 4.退货区 5.次品区 |
| `storehouseNum` | 是 | int | 库位数量 |
| `remarks` | 否 | String | 备注 |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "库区信息保存成功!",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
### 根据仓库编码、库区名称取得库区信息
**简要描述：** 根据仓库编码、库区名称取得库区信息
**请求 URL：** `/storeAreas/v4/getByName`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `houseCode` | 是 | String | 仓库编码 |
| `storeAreaName` | 是 | String | 库区名称 |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "操作成功",
"map": {
"storeArea": {
"storeAreaId": "4028818f702a2ec401702a3590010003",
"houseId": "4028818f702a2ec401702a358ffe0001",
"storeAreaCategroy": 1,
"storehouseNum": null,
"storeAreaName": "缓存库区",
"storeAreaType": null,
"remarks": null
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
### 根据仓库编号获取库区信息列表（分页）
**简要描述：** 根据仓库编号获取库区信息列表（分页）
**请求 URL：** `/storeAreas/v4/getByHouseCode`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `houseCode` | 是 | String | 仓库编码 |
| `page` | 是 | `int` | `页码` |
| `limit` | 是 | `int` | `单页最多显示数量` |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "操作成功",
"map": {
"storeAreaList": {
"pageNum": 1,
"pageSize": 6,
"size": 1,
"startRow": 1,
"endRow": 1,
"total": 1,
"pages": 1,
"list": [
{
"houseName": "聚家云仓wms",//仓库名称
"storeAreaId": "4028818f702a2ec401702a3590010003",//库区Id
"houseId": "4028818f702a2ec401702a358ffe0001",//仓库Id
"storeAreaCategroy": 1,//库区类型
"storeAreaName": "缓存库区"//库区名称
}
],
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1,
"firstPage": 1,
"lastPage": 1
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
### 根据条件获取库区信息列表（分页）
**简要描述：** 根据仓库编码、库区名称取得库区信息 查询条件包括仓库名称、库区名称
**请求 URL：** `/storeAreas/v4/getByHouseName`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `houseName` | 是 | String | 仓库名称 |
| `storeAreaName` | 是 | String | 库区名称 |
| `page` | 是 | `int` | `页码` |
| `limit` | 是 | `int` | `单页最多显示数量` |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "操作成功",
"map": {
"storeAreaList": {
"pageNum": 1,
"pageSize": 6,
"size": 1,
"startRow": 1,
"endRow": 1,
"total": 1,
"pages": 1,
"list": [
{
"houseName": "聚家云仓wms",//仓库名称
"storeAreaId": "4028818f702a2ec401702a3590010003",//库区Id
"houseId": "4028818f702a2ec401702a358ffe0001",//仓库Id
"storeAreaCategroy": 1,//库区类型
"storeAreaName": "缓存库区"//库区名称
}
],
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1,
"firstPage": 1,
"lastPage": 1
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
## 库位信息
### 新增库位信息
**简要描述：** 新增库位信息
**请求 URL：** `/storeHouses/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
- 请求参数示例
```java
{
"houseId": "402881916fb0f2b4016fb100bfed0001",
"storeAreaId": "4028818f70de96b70170dea6517f0005",
"storehouseCode": "kw1002",
"storehouseCategory": 1,
"storehouseType": 1,
"pickingAreaId": "402881916fb0f2b4016fb101b4840010"
}
```
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `houseId` | 是 | String | 仓库id |
| `storeAreaId` | 是 | String | 库区Id |
| `storehouseCode` | 是 | String | 库位编码 |
| `storehouseType` | 是 | String | 库位类型 1.存储区 2.拣货区 3.收货区 4.退货区 5.次品区 |
| `storehouseCategory` | 是 | String | 库位类别 1:存储库位2:拣货库位3:越仓库位4:入库缓存库位5:出库缓存库位6:拣货合并库位7:质检缓存库位8:拣货异常库位9:冻结移库库位10:越库缓存库位|
| `pickingAreaId` | 是 | String | 工作区Id |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "库位信息保存成功!",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
### 修改库位信息
**简要描述：** 修改库位信息
**请求 URL：** `/storeHouses/v4`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
- 请求参数示例
```java
{
"storehouseId":"4028818f70deadf00170deb4b4150005",
"storehouseCategory": 1,
"storehouseType": 1,
"pickingAreaId": "402881916fb0f2b4016fb101b4840010"
}
```
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `storehouseId` | 是 | String | 库位Id |
| `pickingAreaId` | 是 | String | 拣货区域Id |
| `storehouseCategory` | 是 | String | 库位类别 1:存储库位2:拣货库位3:越仓库位4:入库缓存库位5:出库缓存库位6:拣货合并库位7:质检缓存库位8:拣货异常库位9:冻结移库库位10:越库缓存库位|
| `storehouseType` | 是 | String | 库位类型 1.存储区 2.拣货区 3.收货区 4.退货区 5.次品区 |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "库位信息更新成功!",
"map": {}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
### 根据库位编码取得库位信息
**简要描述：** 根据库位编码取得库位信息
**请求 URL：** `/storeHouses/v4/getByCode`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `storehouseCode` | 是 | String | 库位编码 |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "操作成功",
"map": {
"storeHouseList": [
{
"storehouseCode": "2019101801", //库位编码
"pickingAreaId": "402881ee6cf6bc7a016cf9f0b0b300b9",//工作区Id
"storeAreaId": "402881956c4b7361016c4b7ff45e000c",//库区Id
"houseId": "402881956c4b7361016c4b7da54b0000",//仓库Id
"storehouseCategory": 1,//库位类型
"mixedBatches": 0, //是否混放批次(0否 1是)
"mixedStorageAge": 0,//是否混放库龄(0否 1是)
"storehouseType": 1, //库位类型 1:常温 2:冷藏 3:轻型货 4:重型货
"storehouseStatus": 1,//库位状态(0禁用 1启用)
"mixedQuantity": 0,//货物混放数量
"storehouseId": "3886fc9172b6458ab5c947d0b80c69d5",//库位Id
"useState": 0,//使用状态(0未使用 1已使用)
"mixedReleasePeriod": 0 //是否混放效期(0否 1是)
}
]
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
### 根据条件获取库位信息列表（分页）
**简要描述：** 根据条件获取库位信息列表（分页） 查询条件包括仓库名称、库区名称、库位编码
**请求 URL：** `/storeHouses/v4/getByCodeAndName`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `storehouseCode` | 是 | String | 库位编码 |
| `storeAreaName` | 是 | String | 库区名称 |
| `houseName` | 是 | String | 仓库名称 |
| `page` | 是 | `int` | `页码` |
| `limit` | 是 | `int` | `单页最多显示数量` |
**返回示例**
- 调用成功示例
```java
{
"success": true,
"errCode": 0,
"msg": "操作成功",
"map": {
"storeHouseList": {
"pageNum": 1,
"pageSize": 10,
"size": 1,
"startRow": 1,
"endRow": 1,
"total": 1,
"pages": 1,
"list": [
{
"storehouseCode": "2019101801",
"pickingAreaId": "402881ee6cf6bc7a016cf9f0b0b300b9",
"storeAreaId": "402881956c4b7361016c4b7ff45e000c",
"houseId": "402881956c4b7361016c4b7da54b0000",
"storehouseCategory": 1,
"mixedBatches": 0,
"mixedStorageAge": 0,
"storehouseType": 1,
"houseName": "神灵庙",
"storehouseStatus": 1,
"mixedQuantity": 0,
"storehouseId": "3886fc9172b6458ab5c947d0b80c69d5",
"storeAreaName": "冷酷的区",
"useState": 0,
"mixedReleasePeriod": 0
}
],
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1,
"firstPage": 1,
"lastPage": 1
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"message": "sign错误"
}
```
## 工作区信息
### 新增工作区信息
**简要描述：** 新增工作区信息
**请求 URL：** `/pickingAreas/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `pickingAreaCode` | 是 | `String` | `工作区编码` |
| `houseId` | 是 | `String` | `仓库Id` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "工作区信息保存成功!",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
### 根据条件获取工作区信息列表（分页）
**简要描述：** 根据条件获取工作区信息列表（分页），查询条件包括仓库Id、工作区编码。
**请求 URL：** `/pickingAreas/v4/page`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|`limit`|是|`String`|`每页记录数`|
|`page`|是|`String`|`第几页`|
|`houseId` | 否 | `String` | `仓库Id` |
|`pickingAreaCode` | 否 | `String` | `工作区编码` |
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"page": {
"page": 1,
"totalCount": 2,
"total": 11,
"rows": [
{
"pickingAreaId": "402881917099516d017099bc839e000c",//工作区Id
"pickingAreaCode": "13",//工作区编码
"houseId": "402881966e3b15be016e3b1dffff0013"//仓库id
}
]
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
# 入库接口
## 新增入库订单
**简要描述：** 新增入库订单
**请求 URL：** `/inOrders/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`inOrderNo`|是|`String`|`客户订单号`|
|`shipperId`|是|`String`|`货主Id`|
|`shipperName`|是|`String`|`货主名称`|
|`shipperContactName`|否|`String`|`货主联系人`|
|`estimatedArrivalDate`|否|`Date`|`预计到达日`|
|`houseId`|是|`String`|`仓库Id`|
|`houseName`|是|`String`|`仓库名称`|
|`remarks`|否|`String`|`备注`|
|供应商信息|否|-|-|
|`supplierName`|否|`String`|`供应商名称`|
|`supplierCode`|否|`String`|`供应商编码`|
|`supplierId`|否|`String`|`供应商Id`|
|`contactMobilePhone`|否|`String`|`联系人手机`|
|`contactName`|否|`String`|`联系人名称`|
|`contactTelephone`|否|`String`|`联系人电话`|
|`provinceId`|否|`String`|`省Id`|
|`provinceName`|否|`String`|`省名称`|
|`cityId`|否|`String`|`市Id`|
|`cityName`|否|`String`|`市名称`|
|`areaId`|否|`String`|`区Id`|
|`areaName`|否|`String`|`区名称`|
|`streetId`|否|`String`|`街道Id`|
|`streetName`|否|`String`|`街道名称`|
|`address`|否|`String`|`详细地址`|
|承运商信息|否|-|-|
|`carrierId`|否|`String`|`承运商Id`|
|`carrierCode`|否|`String`|`承运商编码`|
|`carrierName`|否|`String`|`承运商名称`|
|`carrierOrderNo`|否|`String`|`承运单号`|
|`driver`|否|`String`|`司机`|
|`licensePlate`|否|`String`|`车牌号`|
|`mobilePhone`|否|`String`|`手机号`|
|`idCard`|否|`String`|`身份证号`|
|`boxesQuantity`|否|`String`|`箱数`|
|订单明细|是|-|-|
|`orderItems`|是|`String`|`订单明细JSON`|
|`goodsId`|是|`String`|`货物Id`|
|`goodsForm`|是|`String`|`货物形态。1正常品；2不良品`|
|`expectQuantity`|是|`Double`|`预期到货数`|
|`price`|否|`Double`|`单价`|
|`totalPrice`|否|`Double`|`金额`|
**请求示例**
```JSON
{
"houseId":"4028805a7307cf08017309d32c4d01d4",
"houseName":"仓库",
"inOrderNo":"0705",
"shipperId":"4028805a7296f7dd0172a659179a050a",
"shipperName":"货主",
"orderItems":"[{'goodsId':'4028805a72b6d91c0172bbfb4aa5019a','goodsForm':'1','expectQuantity':'50'}]"
}
```
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "订单新增成功！",
"map": {
"inOrderId": "4028368170dd55f20170dd644a540000",
"inOrderStatus": 1 //订单状态 1:新订单 2:部分生成任务单 3:全部生成任务单 5:已完成收货 6:已取消 7:已关闭
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 新增入库订单_Code
**简要描述：** 新增入库订单_Code版
**请求 URL：** `/inOrders/v4_1`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`inOrderNo`|是|`String`|`客户订单号`|
|`shipperCode`|是|`String`|`货主编码`|
|`shipperName`|是|`String`|`货主名称`|
|`shipperContactName`|否|`String`|`货主联系人`|
|`estimatedArrivalDate`|否|`Date`|`预计到达日`|
|`houseCode`|是|`String`|`仓库编码`|
|`houseName`|是|`String`|`仓库名称`|
|`remarks`|否|`String`|`备注`|
|供应商信息|否|-|-|
|`supplierName`|否|`String`|`供应商名称`|
|`supplierCode`|否|`String`|`供应商编码`|
|`contactMobilePhone`|否|`String`|`联系人手机`|
|`contactName`|否|`String`|`联系人名称`|
|`contactTelephone`|否|`String`|`联系人电话`|
|`provinceId`|否|`String`|`省Id`|
|`provinceName`|否|`String`|`省名称`|
|`cityId`|否|`String`|`市Id`|
|`cityName`|否|`String`|`市名称`|
|`areaId`|否|`String`|`区Id`|
|`areaName`|否|`String`|`区名称`|
|`streetId`|否|`String`|`街道Id`|
|`streetName`|否|`String`|`街道名称`|
|`address`|否|`String`|`详细地址`|
|承运商信息|否|-|-|
|`carrierCode`|否|`String`|`承运商编码`|
|`carrierName`|否|`String`|`承运商名称`|
|`carrierOrderNo`|否|`String`|`承运单号`|
|`driver`|否|`String`|`司机`|
|`licensePlate`|否|`String`|`车牌号`|
|`mobilePhone`|否|`String`|`手机号`|
|`idCard`|否|`String`|`身份证号`|
|`boxesQuantity`|否|`String`|`箱数`|
|订单明细|是|-|-|
|`orderItems`|是|`String`|`订单明细JSON`|
|`goodsCode`|是|`String`|`货物编码`|
|`goodsForm`|是|`String`|`货物形态。1正常品；2不良品`|
|`expectQuantity`|是|`Double`|`预期到货数`|
|`price`|否|`Double`|`单价`|
|`totalPrice`|否|`Double`|`金额`|
**请求示例**
```JSON
{
"houseCode":"CK",
"houseName":"仓库",
"inOrderNo":"0705",
"shipperCode":"HZ",
"shipperName":"货主",
"orderItems":"[{'goodsCode':'HW','goodsForm':'1','expectQuantity':'50'}]"
}
```
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "订单新增成功！",
"map": {
"inOrderId": "4028368170dd55f20170dd644a540000",
"inOrderStatus": 1 //订单状态 1:新订单 2:部分生成任务单 3:全部生成任务单 5:已完成收货 6:已取消 7:已关闭
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 快速入库
**简要描述：** 快速入库
**请求 URL：** `/inOrders/v4/fast`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`isUpTask`|是|`String`|`0：保存，1：保存并上架`|
|`inOrderNo`|是|`String`|`客户订单号`|
|`shipperId`|是|`String`|`货主Id`|
|`shipperContactName`|否|`String`|`货主联系人`|
|`estimatedArrivalDate`|否|`Date`|`预计到达日`|
|`houseId`|是|`String`|`仓库Id`|
|`remarks`|否|`String`|`备注`|
|`supplierId`|否|`string`|`供货商Id`|
|`provinceName`|否|`string`|`省名`|
|`cityName`|否|`string`|`市名`|
|`areaName`|否|`string`|`区名`|
|`streetName`|否|`string`|`街道名称`|
|`address`|否|`string`|`详细地址`|
|`contactName`|否|`string`|`联系人名称`|
|`contactMobilePhone`|否|`string`|`联系人手机`|
|`contactTelephone`|否|`string`|`联系人电话`|
|`carrierId`|否|`string`|`承运商Id`|
|`carrierOrderNo`|否|`string`|`承运单号`|
|`driver`|否|`string`|`司机`|
|`licensePlate`|否|`string`|`车牌号`|
|`boxesQuantity`|否|`String`|`箱数`|
|`mobilePhone`|否|`string`|`手机号`|
|`idCard`|否|`string`|`身份证号`|
|采购单明细（orderItems）|--|--|--|
|`goodsId`|是|`string`|`货物Id`|
|`goodsForm`|是|`String`|`货物形态1:正常品，2：不良品`|
|`expectQuantity`|是|`double`|`预期到货数`|
|`price`|否|`double`|`单价`|
|`totalPrice`|否|`double`|`金额`|
|`produceDate`|否|`Date`|`生产日期`|
|`dueDate`|否|`Date`|`到期日`|
|`batchNo`|否|`String`|`批次号`|
|`containerId`|否|`String`|`容器Id`|
|`storehouseId`|是|`String`|`库位Id`|
**请求示例**
```JSON
{
"isUpTask":"0",
"houseId":"4028805a7307cf08017309d32c4d01d4",
"inOrderNo":"0705",
"shipperId":"4028805a7296f7dd0172a659179a050a",
"orderItems":"[{'goodsId':'4028805a72b6d91c0172bbfb4aa5019a','goodsForm':'1','expectQuantity':'50','storehouseId':'4028805a7309d79401730cefa4f10011'}]"
}
```
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "订单新增成功！",
"map": {
"inOrderId": "4028368170dd55f20170dd644a540000",
"inFastOrderStatus": 1 //快速入库订单状态 1:新订单 2：已入库 3：已关闭
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 快速入库_Code
**简要描述：** 快速入库_Code版
**请求 URL：** `/inOrders/v4/fast_1`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`isUpTask`|是|`String`|`0：保存，1：保存并上架`|
|`inOrderNo`|是|`String`|`客户订单号`|
|`shipperCode`|是|`String`|`货主编码`|
|`shipperContactName`|否|`String`|`货主联系人`|
|`estimatedArrivalDate`|否|`Date`|`预计到达日`|
|`houseCode`|是|`String`|`仓库编码`|
|`remarks`|否|`String`|`备注`|
|`supplierCode`|否|`string`|`供货商编码`|
|`provinceName`|否|`string`|`省名`|
|`cityName`|否|`string`|`市名`|
|`areaName`|否|`string`|`区名`|
|`streetName`|否|`string`|`街道名称`|
|`address`|否|`string`|`详细地址`|
|`contactName`|否|`string`|`联系人名称`|
|`contactMobilePhone`|否|`string`|`联系人手机`|
|`contactTelephone`|否|`string`|`联系人电话`|
|`carrierCode`|否|`string`|`承运商编码`|
|`carrierOrderNo`|否|`string`|`承运单号`|
|`driver`|否|`string`|`司机`|
|`licensePlate`|否|`string`|`车牌号`|
|`boxesQuantity`|否|`String`|`箱数`|
|`mobilePhone`|否|`string`|`手机号`|
|`idCard`|否|`string`|`身份证号`|
|采购单明细（orderItems）|--|--|--|
|`goodsCode`|是|`string`|`货物编码`|
|`goodsForm`|是|`String`|`货物形态1:正常品，2：不良品`|
|`expectQuantity`|是|`double`|`预期到货数`|
|`price`|否|`double`|`单价`|
|`totalPrice`|否|`double`|`金额`|
|`produceDate`|否|`Date`|`生产日期`|
|`dueDate`|否|`Date`|`到期日`|
|`batchNo`|否|`String`|`批次号`|
|`containerCode`|否|`String`|`容器编码`|
|`storehouseCode`|是|`String`|`库位编码`|
**请求示例**
```JSON
{
"isUpTask":"0",
"houseCode":"CK",
"inOrderNo":"0705",
"shipperCode":"HZ",
"orderItems":"[{'goodsCode':'HW','goodsForm':'1','expectQuantity':'50','storehouseCode':'KW'}]"
}
```
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "订单新增成功！",
"map": {
"inOrderId": "4028368170dd55f20170dd644a540000",
"inFastOrderStatus": 1 //快速入库订单状态 1:新订单 2：已入库 3：已关闭
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据条件获取入库订单信息
**简要描述：** 根据条件获取入库订单信息，查询条件包括入库订单号、客户订单号
**请求 URL：** `/inOrders/v4/info`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一项|
|`inOrderNo`|否|`String`|`客户订单号`|
|`inWMSOrderNo`|否|`String`|`WMS订单号`|
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"orderSupplier": {
"inOrderId": "4028368170d9fbfd0170da0410410001",
"supplierId": "4028368170c4cc410170c4fa52a6002e",
"supplierCode": "gys001",
"supplierName": "漂亮",
"provinceId": "13",
"provinceName": "河北省",
"cityId": "1302",
"cityName": "唐山市",
"areaId": "130203",
"areaName": "路北区",
"streetId": "130203006",
"streetName": "机场路街道办事处",
"address": "411 Eldon Mission",
"contactName": "规范DVM",
"contactMobilePhone": "15645654545",
"contactTelephone": "15654545465"
},
"orderCarrier": {
"inOrderId": "4028368170d9fbfd0170da0410410001",
"carrierId": "4028368170c4cc410170c5019a490030",
"carrierCode": "pp",
"carrierName": "其他物流_可空",
"carrierOrderNo": "ken12432548",
"driver": "",
"licensePlate": "",
"boxesQuantity": 10,
"mobilePhone": null,
"idCard": null
},
"order": {
"inOrderId": "4028368170d9fbfd0170da0410410001",
"inOrderNo": "rk691119",
"inWMSOrderNo": "RK2003140564",
"houseId": "4028368170c4cc410170c4deeb820010",
"houseName": "看守所",
"shipperId": "4028368170c4cc410170c4f1ac3e0024",
"shipperName": "刘三姐",
"shipperContactName": "",
"estimatedArrivalDate": "1970-01-19 16:03:26",
"inType": 1,
"inOrderType": 1,
"skuQuantity": 2,
"totalVolume": 0.0,
"totalWeight": 0.0,
"totalAmount": 3740.0,
"wholeQuantity": 220.0,
"scatteredQuantity": 0.0,
"expectedQuantity": 220.0,
"inOrderStatus": 1,
"feedbackStatus": 0,
"feedbackTimes": 0,
"itemQuantity": 2,
"printTimes": 0,
"printTime": null,
"orderSource": 1,
"createorId": "erpId",
"createName": "ERP用户",
"createTime": 1584205664000,
"updaterId": "erpId",
"updateName": "ERP用户",
"updateTime": 1584260887000,
"remarks": "备注PCI",
"inFastOrderStatus": 1,
"actualQuantity": 0.0,
"actualTotalPrice": 0.0
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据条件获取入库订单的状态
**简要描述：** 根据条件获取入库订单的状态，查询条件包括入库订单号、客户订单号
**请求 URL：** `/inOrders/v4/status`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一项|
|`inOrderNo`|否|`String`|`客户订单号`|
|`inWMSOrderNo`|否|`String`|`WMS订单号`|
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"inOrder": {
"inFastOrderStatus": 1,
"inOrderNo": "rk691119",
"inWMSOrderNo": "RK2003140564",
"inOrderId": "4028368170d9fbfd0170da0410410001",
"inOrderStatus": 1,
"feedbackStatus": 0
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据入库订单Id获取入库订单明细
**简要描述：** 根据入库订单Id获取入库订单明细
**请求 URL：** `/inOrders/v4/items`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|`inOrderId`|是|`String`|`入库订单Id`|
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"inOrderItemList": [
{
"inOrderItemId": "4028368170d9fbfd0170da0410d70004",
"inOrderId": null,
"supplierId": null,
"supplierCode": null,
"supplierName": null,
"goodsId": "4028368170c4cc410170c5032cbe0039",
"goodsCode": "hw002",
"goodsName": "唇膏",
"goodBarcode": "cg",
"pickingRate": 1.0,
"goodsCategoryId": null,
"goodsCategoryName": null,
"goodstCode": null,
"specificationType": null,
"goodsForm": 1,
"containerId": null,
"containerCode": null,
"storehouseId": null,
"storehouseCode": null,
"produceDate": null,
"dueDate": null,
"batchNo": null,
"expectQuantity": 120.0,
"actualQuantity": null,
"scatteredQuantity": 0.0,
"wholeQuantity": 120.0,
"price": null,
"totalPrice": null,
"volume": null,
"weight": null,
"sortNo": 2
},
{
"inOrderItemId": "4028368170d9fbfd0170da0410d20003",
"inOrderId": null,
"supplierId": null,
"supplierCode": null,
"supplierName": null,
"goodsId": "4028368170c4cc410170c502ccba0035",
"goodsCode": "hw001",
"goodsName": "面膜",
"goodBarcode": "mm",
"pickingRate": 1.0,
"goodsCategoryId": null,
"goodsCategoryName": null,
"goodstCode": null,
"specificationType": "",
"goodsForm": 1,
"containerId": null,
"containerCode": null,
"storehouseId": null,
"storehouseCode": null,
"produceDate": null,
"dueDate": null,
"batchNo": null,
"expectQuantity": 100.0,
"actualQuantity": null,
"scatteredQuantity": 0.0,
"wholeQuantity": 100.0,
"price": null,
"totalPrice": null,
"volume": null,
"weight": null,
"sortNo": 1
}
]
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据条件取消入库订单
**简要描述：** 根据条件取消入库订单，查询条件包括入库订单Id、入库订单号、客户订单号
**请求 URL：** `/inOrders/v4/cancelled`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一项|
|`inOrderId`|否|`String`|`入库订单Id`|
|`inOrderNo`|否|`String`|`客户订单号`|
|`inWMSOrderNo`|否|`String`|`WMS订单号`|
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "单据全部取消成功",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
# 出库接口
## 新增出库订单
**简要描述：** 新增出库订单
**请求 URL：** `/outOrders/v4`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`houseId`|是|`String`|`仓库Id`|
|`houseName`|是|`String`|`仓库名称`|
|`outOrderNo`|是|`String`|`出库客户订单号`|
|`shipperId`|是|`String`|`货主Id`|
|`shipperName`|是|`String`|`货主名称`|
|`collectionType`|否|`String`|`收款方式。1款到发货;2快递代收;3货到付款`|
|`sellerRemarks`|否|`String`|`卖家备注`|
|`orderType`|是|`String`|`订单类型。1线上订单；2线下订单`|
|`plannedOutTime`|否|`String`|`计划出库时间`|
|`outType`|否|`int`|`出库类型(默认为销售出库) 销售出库= 1;换货出库= 2;补发出库 = 3;其他出库= 4;普通出库 = 5;调拨出库 = 6;采购退货出库 = 7;货权转移 8;`|
|客户|是|-|-|
|`customerId`|是|`String`|`客户Id（线上订单不填）`|
|`customerCode`|是|`String`|`客户编码（线上订单不填）`|
|`customerName`|是|`String`|`客户名称（线上订单不填）`|
|`contactName`|是|`String`|`联系人名称`|
|`mobile`|是|`String`|`联系人手机`|
|`provinceId`|是|`String`|`省Id`|
|`provinceName`|是|`String`|`省名称`|
|`cityId`|是|`String`|`市Id`|
|`cityName`|是|`String`|`市名称`|
|`areaId`|是|`String`|`区Id`|
|`areaName`|是|`String`|`区名称`|
|`streetId`|否|`String`|`街道Id`|
|`streetName`|否|`String`|`街道名称`|
|`address`|是|`String`|`详细地址`|
|`buyerRemarks`|否|`String`|`买家备注`|
|承运商|否|-|-|
|`carrierId`|否|`String`|`承运商Id`|
|`carrierName`|否|`String`|`承运商名称`|
|`carrierCode`|否|`String`|`承运商编码`|
|`driver`|否|`String`|`司机`|
|`licensePlate`|否|`String`|`车牌号`|
|`mobilePhone`|否|`String`|`手机号`|
|`idCard`|否|`String`|`身份证号`|
|`carrierOrderNo`|否|`String`|`承运单号`|
|`outOrderItems`|是|`String`|`订单明细JSON`|
|明细|-|-|-|
|`goodsId`|是|`String`|`货物Id`|
|`goodsForm`|是|`String`|`货物形态。1正常品；2不良品`|
|`batchNo`|否|`String`|`批次号`|
|`produceDate`|否|`date`|`生产日期`|
|`planOutQuantity`|是|`String`|`出库数量`|
|`price`|否|`Double`|`单价`|
|`totalPrice`|否|`Double`|`金额`|
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "订单保存成功！",
"map": {
"outOrderId": "4028368170deeaba0170df04141f0006",
"outOrderStatus": 1
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 新增出库订单_Code
**简要描述：** 新增出库订单 code版
**请求 URL：** `/outOrders/v4_1`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`houseCode`|是|`String`|`仓库编码`|
|`houseName`|是|`String`|`仓库名称`|
|`outOrderNo`|是|`String`|`出库客户订单号`|
|`shipperCode`|是|`String`|`货主编码`|
|`shipperName`|是|`String`|`货主名称`|
|`collectionType`|否|`String`|`收款方式。1款到发货;2快递代收;3货到付款`|
|`sellerRemarks`|否|`String`|`卖家备注`|
|`orderType`|是|`String`|`订单类型。1线上订单；2线下订单；3调拨订单；4货权转移`|
|`plannedOutTime`|否|`String`|`计划出库时间`|
|`outType`|否|`int`|`出库类型(默认为销售出库) 销售出库= 1;换货出库= 2;补发出库 = 3;其他出库= 4;普通出库 = 5;调拨出库 = 6;采购退货出库 = 7;货权转移 8;`|
|客户|是|-|-|
|`customerCode`|是|`String`|`客户编码（线上订单不填）`|
|`customerName`|是|`String`|`客户名称（线上订单不填）`|
|`contactName`|是|`String`|`联系人名称`|
|`mobile`|是|`String`|`联系人手机`|
|`provinceName`|是|`String`|`省名称`|
|`cityName`|是|`String`|`市名称`|
|`areaName`|是|`String`|`区名称`|
|`streetName`|否|`String`|`街道名称`|
|`address`|是|`String`|`详细地址`|
|`buyerRemarks`|否|`String`|`买家备注`|
|承运商|否|-|-|
|`carrierName`|否|`String`|`承运商名称`|
|`carrierCode`|否|`String`|`承运商编码`|
|`driver`|否|`String`|`司机`|
|`licensePlate`|否|`String`|`车牌号`|
|`mobilePhone`|否|`String`|`手机号`|
|`idCard`|否|`String`|`身份证号`|
|`carrierOrderNo`|否|`String`|`承运单号`|
|`outOrderItems`|是|`String`|`订单明细JSON`|
|明细|-|-|-|
|`goodsCode`|是|`String`|`货物编码`|
|`goodsForm`|是|`String`|`货物形态。1正常品；2不良品`|
|`batchNo`|否|`String`|`批次号`|
|`produceDate`|否|`date`|`生产日期`|
|`scatteredQuantity`|否|`String`|`散件数`|
|`wholeQuantity`|否|`String`|`整件数`|
|`planOutQuantity`|是|`String`|`出库数量`|
|`price`|否|`Double`|`单价`|
|`totalPrice`|否|`Double`|`金额`|
**调用示例**
```JSON
{
"orderType": "1",
"houseCode": "仓库编码",
"shipperCode": "货主编码",
"address": "河南省郑州市xx区xx路xx号",
"contactName": "张三",
"mobile": "13012345678",
"shipperName": "货主名称",
"cityName": "郑州市",
"outOrderNo": "Test12300002",
"provinceName": "河南省",
"houseName": "郑州中转仓",
"areaName": "金水区",
"outOrderItems": "[{'price': 2.5,'goodsForm': '1','planOutQuantity': '1','goodsCode': 'K016805743000'}]",
"carrierName": "xx快递",
"carrierCode": "快递编码"
}
```
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "订单保存成功！",
"map": {
"outOrderId": "4028368170deeaba0170df04141f0006",
"outOrderStatus": 1
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 快速出库
**简要描述：** 快速出库
**请求 URL：** `/outOrders/v4/fast`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`outOrderNo`|是|`String`|`客户订单号`|
|`houseId`|是|`String`|`仓库Id`|
|`shipperId`|是|`String`|`货主Id`|
|`plannedOutTime`|否|`String`|`计划出库时间`|
|`sellerRemarks`|否|`String`|`卖家备注`|
|客户|是|-|-|
|`customerId`|是|`String`|`客户Id（线上订单不填）`|
|`contactName`|是|`String`|`联系人名称`|
|`mobile`|是|`String`|`联系人手机`|
|`provinceName`|是|`String`|`省名称`|
|`cityName`|是|`String`|`市名称`|
|`areaName`|是|`String`|`区名称`|
|`address`|是|`String`|`详细地址`|
|`buyerRemarks`|否|`String`|`买家备注`|
|`outOrderItems`|是|`String`|`订单明细JSON字符串`|
|明细|-|-|-|
|`goodsId`|是|`String`|`货物Id`|
|`goodsForm`|是|`String`|`货物形态。1正常品；2不良品`|
|`planOutQuantity`|是|`Double`|`出库数量`|
**调用示例**
```JSON
{
"outOrderNo": "XX20200328004",
"houseId": "4028805a710aa90201710c8f44e600c3",
"shipperId": "4028805a710aa90201710d0e1d490183",
"customerId": "4028805a710aa90201710d0e6cfe0185",
"contactName": "张三",
"mobile": "15612345678",
"provinceName": "北京市",
"cityName": "市辖区",
"areaName": "东城区",
"address": "沈家胡同100号",
"outOrderItems": "[{'goodsId': 'bf32f2ef3882454cb7f48c050a8d2e41', 'goodsForm':'1', 'planOutQuantity': '1'},{'goodsId': '4028805a710aa90201710d45af2f01ed', 'goodsForm':'1', 'planOutQuantity': '1'}]"
}
```
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "快速出库成功！",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 快速出库_Code
**简要描述：** 快速出库Code版
**请求 URL：** `/outOrders/v4/fast_1`
**请求方式：** POST
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|基础信息|是|-|-|
|`outOrderNo`|是|`String`|`客户订单号`|
|`houseCode`|是|`String`|`仓库编码`|
|`shipperCode`|是|`String`|`货主编码`|
|`plannedOutTime`|否|`String`|`计划出库时间`|
|`sellerRemarks`|否|`String`|`卖家备注`|
|客户|是|-|-|
|`customerCode`|是|`String`|`客户编码（线上订单不填）`|
|`contactName`|是|`String`|`联系人名称`|
|`mobile`|是|`String`|`联系人手机`|
|`provinceName`|是|`String`|`省名称`|
|`cityName`|是|`String`|`市名称`|
|`areaName`|是|`String`|`区名称`|
|`address`|是|`String`|`详细地址`|
|`buyerRemarks`|否|`String`|`买家备注`|
|`outOrderItems`|是|`String`|`订单明细JSON字符串`|
|明细|-|-|-|
|`goodsCode`|是|`String`|`货物编码`|
|`goodsForm`|是|`String`|`货物形态。1正常品；2不良品`|
|`planOutQuantity`|是|`Double`|`出库数量`|
**调用示例**
```JSON
{
"outOrderNo": "XX20200328004",
"houseCode": "4028805a710aa90201710c8f44e600c3",
"shipperCode": "4028805a710aa90201710d0e1d490183",
"customerCode": "4028805a710aa90201710d0e6cfe0185",
"contactName": "张三",
"mobile": "15612345678",
"provinceName": "北京市",
"cityName": "市辖区",
"areaName": "东城区",
"address": "沈家胡同100号",
"outOrderItems": "[{'goodsCode': 'test1', 'goodsForm':'1', 'planOutQuantity': '1'},{'goodsCode': 'test2', 'goodsForm':'1', 'planOutQuantity': '1'}]"
}
```
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "快速出库成功！",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据条件获取出库订单信息
**简要描述：** 根据条件获取出库订单信息，查询条件包括出库订单号、客户订单号
**请求 URL：** `/outOrders/v4/info`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一项|
|`outOrderNo`|否|`String`|`客户订单号`|
|`outWMSOrderNo`|否|`String`|`出库WMS订单号`|
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"outOrderCarrier": {
"outOrderId": "4028368170deeaba0170df04141f0006",
"carrierId": "4028368170c4cc410170c5019a490030",
"carrierCode": "pp",
"carrierName": "可空",
"carrierOrderNo": "jj1",
"driver": "",
"licensePlate": "",
"mobilePhone": "15222255555",
"idCard": "111111111111111111"
},
"outOrderCustomer": {
"outOrderId": "4028368170deeaba0170df04141f0006",
"customerId": null,
"customerCode": null,
"customerName": null,
"contactName": "fwwwwe",
"mobile": "14444444444",
"tel": null,
"provinceId": "41",
"provinceName": "河南省",
"cityId": "4102",
"cityName": "开封市",
"areaId": "410202",
"areaName": "龙亭区",
"streetId": "410202002",
"streetName": "午朝门街道办事处",
"address": "hhhtr",
"buyerRemarks": "hwe"
},
"outOrder": {
"outOrderId": "4028368170deeaba0170df04141f0006",
"houseId": "4028368170c4cc410170c4deeb820010",
"houseName": "看守所",
"outOrderNo": "tian25325674",
"outWMSOrderNo": "CK2C200315715",
"shipperId": "4028368170c4cc410170c4f1ac3e0024",
"shipperName": "刘三姐",
"collectionType": 1,
"outType": 1,
"orderType": 1,
"salePlatform": null,
"store": "",
"outOrderStatus": 1,
"feedbackStatus": 0,
"itemQuantity": 2,
"wholeQuantity": 2.0,
"scatteredQuantity": 0.0,
"planOutTotalQuantity": 2.0,
"actualOutTotalQuantity": 0.0,
"sellerRemarks": "mmm",
"orderSource": 2,
"totalVolume": 0.0,
"totalWeight": 0.0,
"totalPrice": 77.0,
"createorId": "erpId",
"createName": "ERP用户",
"createTime": 1584289551000,
"updaterId": null,
"updateName": null,
"updateTime": null,
"plannedOutTime": null,
"skuquantity": 2
}
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据出库订单Id获取出库订单明细
**简要描述：** 根据出库订单Id获取出库订单明细
**请求 URL：** `/outOrders/v4/items`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
|`outOrderId`|是|`String`|`出库订单Id`|
**返回示例**
- 调用成功示例
```JSON
{
"success": true,
"errCode": 0,
"msg": "请求成功",
"map": {
"outOrderItemList": [
{
"outOrderItemId": "4028368170deeaba0170df041425000a",
"outOrderId": "4028368170deeaba0170df04141f0006",
"goodsId": "4028368170c4cc410170c502ccba0035",
"goodsCode": "hw001",
"goodsName": "面膜",
"goodBarcode": "mm",
"pickingRate": 1.0,
"goodsCategoryId": "4028368170c4cc410170c4e848ce0022",
"goodsCategoryName": "化妆品",
"goodstCode": "",
"goodsColor": "",
"specificationType": "",
"goodsSize": "",
"price": 33.0,
"totalPrice": 33.0,
"volume": null,
"weight": null,
"goodsForm": 1,
"batchNo": "",
"produceDate": null,
"wholeQuantity": 1.0,
"scatteredQuantity": 0.0,
"planOutQuantity": 1.0,
"actualOutQuantity": 0.0,
"sortNo": 1,
"goodsUnitId": "4028368170c4cc410170c502ccb80033",
"goodsUnitName": "盒"
},
{
"outOrderItemId": "4028368170deeaba0170df041439000b",
"outOrderId": "4028368170deeaba0170df04141f0006",
"goodsId": "4028368170c4cc410170c5032cbe0039",
"goodsCode": "hw002",
"goodsName": "唇膏",
"goodBarcode": "cg",
"pickingRate": 1.0,
"goodsCategoryId": "4028368170c4cc410170c4e848ce0022",
"goodsCategoryName": "化妆品",
"goodstCode": null,
"goodsColor": null,
"specificationType": null,
"goodsSize": null,
"price": 44.0,
"totalPrice": 44.0,
"volume": null,
"weight": null,
"goodsForm": 1,
"batchNo": "2",
"produceDate": 1583078400000,
"wholeQuantity": 1.0,
"scatteredQuantity": 0.0,
"planOutQuantity": 1.0,
"actualOutQuantity": 0.0,
"sortNo": 2,
"goodsUnitId": "4028368170c4cc410170c502ccb80033",
"goodsUnitName": "盒"
}
]
}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据条件取消出库订单
**简要描述：** 根据条件取消出库订单，查询条件包括出库订单Id、出库订单号、客户订单号
**请求 URL：** `/outOrders/v4/cancelled`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一项|
|`outOrderId`|否|`String`|`出库订单Id`|
|`outOrderNo`|否|`String`|`客户订单号`|
|`outWMSOrderNo`|否|`String`|`WMS订单号`|
**返回示例**
- 调用成功示例
```JSON
{
"success": false,
"errCode": 0,
"msg": "操作成功!",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据条件取消快速出库订单
**简要描述：** 根据条件取消快速出库订单，查询条件包括出库订单Id、出库订单号、客户订单号
**请求 URL：** `/outOrders/v4/fast_1/cancelled`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一项|
|`outOrderId`|否|`String`|`出库订单Id`|
|`outOrderNo`|否|`String`|`客户订单号`|
|`outWMSOrderNo`|否|`String`|`WMS订单号`|
**返回示例**
- 调用成功示例
```JSON
{
"success": false,
"errCode": 0,
"msg": "操作成功!",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
## 根据条件取消快速出库确认订单
**简要描述：** 根据条件取消出库确认订单，查询条件包括出库订单Id、出库订单号、客户订单号
**请求 URL：** `/outOrders/v4/fast_1/cancelledConfirm`
**请求方式：** PUT
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
||||以下参数至少选择一项|
|`outOrderId`|否|`String`|`出库订单Id`|
|`outOrderNo`|否|`String`|`客户订单号`|
|`outWMSOrderNo`|否|`String`|`WMS订单号`|
**返回示例**
- 调用成功示例
```JSON
{
"success": false,
"errCode": 0,
"msg": "操作成功!",
"map": {}
}
```
- 调用失败示例
```JSON
{
"success": false,
"errCode": -1,
"msg": "请求异常",
"map": {}
}
```
# 库存接口
## 货物库存
**简要描述：** 根据货物Id,条码,编码查询库存
**请求 URL：** `/inventorys/v4/quantity`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `shipperId` | 是 | `string` | 货主Id |
| | | | 以下三选一 |
| `goodsId` | 是 | `string` | 商品Id |
| `goodsCode` | 是 | `string` | 商品编码 |
| `goodBarcode` | 是 | `string` | 商品条码 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"goodsQuantity": {
"avaliableQuantity": 12.000000,
"goodsId": "402881b06e25e45c016e25e535200004"
}
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "请求处理异常",
}
```
## 货主条件查询库存
**简要描述：** 根据货主Id、货主编码查询库存
**请求 URL：** `/inventorys/v4/list/by/shipper`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `shipperCode` | 是 | `string` | 货主编码 |
| `shipperId` | 是 | `string` | 货主Id |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"stockList": [
{
"inUpTaskId": "402881917099516d017099bdb9160010",//入库任务Id
"houseId": "402881966e3b15be016e3b1dffff0013",//仓库Id
"houseName": "默认仓库",//仓库名称
"storeAreaId": "402881966e3b15be016e3b1e7b14001d",//库区Id
"storeAreaName": "库区一",//库区名称
"storehouseId": "402881917099516d017099bd1752000e",//库位Id
"storehouseCode": "1334",//库位编码
"containerId": null,//容器Id
"containerCode": null,//容器编码
"goodsId": "402881917099516d017099b9b7e90001",//商品Id
"pickingRate": 1.0,//包装率
"goodsForm": 1,//货物形态
"produceDate": 1581782400000,//生成日期
"dueDate": 1582646400000,//到期日
"batchNo": null,//批次号
"wholeQuantity": 10.0,//整件数
"scatteredQuantity": 0.0,//散件数
"stockQuantity": 10.0,//库存数量
"outLockQuantity": 0.0,//出库锁定
"frozenQuantity": 0.0,//冻结数量
"avaliableQuantity": 10.0,//可用库存数量
"inboundTime": 1583127313000,//入库时间
"receiveTime": 1583127313000,//收货时间
"modifyReason": null,//修改原因
"supplierId": "",//供应商Id
"groupSupplierId": null,
"supplierCode": "",//供应商编码
"supplierName": "",//供应商名称
"goodsCode": "PG",//货物编码
"goodsName": "pg",//货物名称
"goodBarcode": "PG",//货物条码
"goodsCategoryId": "4028818f7037189601703729b5fc0001",//货物类别Id
"goodsCategoryName": "淘宝",//货物类别名称
"shelfLife": 10,//保质期
"shipperId": "402881966e1f6789016e1f6f4c5e0000",//货主Id
"shipperName": "邪眸白虎",//货主名称
"goodstCode": "",//货号
"goodsColor": "",//货物颜色
"price": 0.0,//货物单价
"totalPrice": 0.0,//总价
"specificationType": "",//货物规格
"goodsSize": "",//货物大小
"totalVolume": 0.0,//总体积
"volume": 0.0,//单体积
"weight": 0.0,//单重量
"totalWeight": 0.0,//总重量
"goodsUnitId": "402881956c605fc5016c60844e3901a9",//货物单位Id
"goodsUnitName": "箱",//单位名称
"mnemonicCode": "",//助记码
"goodsBrand": "",//货物条码
"storehouseType": 1,//库位类型
"remainingTime": -17,//剩余天数
"libraryAge": 12,//库龄
"boxNo": null,//箱码
"storehouseCategory": 1,//库位类别,
"shipperCode": "hz20191031",//货主编码
"houseCodeCode": "12311111"//仓库编码
}
]
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```
## 组合条件查询库存
**简要描述：** 根据货主编码、仓库编码、库区名称、库位编码、货物编码、货物条码查询库存
**请求 URL：** `/inventorys/v4/list`
**请求方式：** GET
**需要认证：** 是
**请求参数：**
| 参数名 | 必选 | 类型 | 说明 |
|:----:|:---:|:-----:|:-----:|
| `shipperCode` | 是 | `string` | 货主Id |
| `houseCode` | 是 | `string` | 仓库编码 |
| `storehouseCode` | 是 | `string` | 库位编码 |
| `storeAreaName` | 是 | `string` | 库区名称 |
| `goodsCode` | 是 | `string` | 货物编码 |
| `goodBarcode` | 是 | `string` | 货物条码 |
**返回示例**
```java
{
"success": true,
"errCode": 0,
"msg": "处理成功",
"map": {
"stockList": [
{
"inUpTaskId": "402881917099516d017099bdb9160010",//入库任务Id
"houseId": "402881966e3b15be016e3b1dffff0013",//仓库Id
"houseName": "默认仓库",//仓库名称
"storeAreaId": "402881966e3b15be016e3b1e7b14001d",//库区Id
"storeAreaName": "库区一",//库区名称
"storehouseId": "402881917099516d017099bd1752000e",//库位Id
"storehouseCode": "1334",//库位编码
"containerId": null,//容器Id
"containerCode": null,//容器编码
"goodsId": "402881917099516d017099b9b7e90001",//商品Id
"pickingRate": 1.0,//包装率
"goodsForm": 1,//货物形态
"produceDate": 1581782400000,//生成日期
"dueDate": 1582646400000,//到期日
"batchNo": null,//批次号
"wholeQuantity": 10.0,//整件数
"scatteredQuantity": 0.0,//散件数
"stockQuantity": 10.0,//库存数量
"outLockQuantity": 0.0,//出库锁定
"frozenQuantity": 0.0,//冻结数量
"avaliableQuantity": 10.0,//可用库存数量
"inboundTime": 1583127313000,//入库时间
"receiveTime": 1583127313000,//收货时间
"modifyReason": null,//修改原因
"supplierId": "",//供应商Id
"groupSupplierId": null,
"supplierCode": "",//供应商编码
"supplierName": "",//供应商名称
"goodsCode": "PG",//货物编码
"goodsName": "pg",//货物名称
"goodBarcode": "PG",//货物条码
"goodsCategoryId": "4028818f7037189601703729b5fc0001",//货物类别Id
"goodsCategoryName": "淘宝",//货物类别名称
"shelfLife": 10,//保质期
"shipperId": "402881966e1f6789016e1f6f4c5e0000",//货主Id
"shipperName": "邪眸白虎",//货主名称
"goodstCode": "",//货号
"goodsColor": "",//货物颜色
"price": 0.0,//货物单价
"totalPrice": 0.0,//总价
"specificationType": "",//货物规格
"goodsSize": "",//货物大小
"totalVolume": 0.0,//总体积
"volume": 0.0,//单体积
"weight": 0.0,//单重量
"totalWeight": 0.0,//总重量
"goodsUnitId": "402881956c605fc5016c60844e3901a9",//货物单位Id
"goodsUnitName": "箱",//单位名称
"mnemonicCode": "",//助记码
"goodsBrand": "",//货物条码
"storehouseType": 1,//库位类型
"remainingTime": -17,//剩余天数
"libraryAge": 12,//库龄
"boxNo": null,//箱码
"storehouseCategory": 1,//库位类别
"shipperCode": "hz20191031",//货主编码
"houseCodeCode": "12311111"//仓库编码
}
]
}
}
```
- 调用失败示例
```java
{
"success": false,
"errCode": -1,
"msg": "处理数据异常!",
"map": {}
}
```