获取当前用户执行中的订单
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/list |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
pageIndex |
是 |
int |
起始页(默认1) |
pageSize |
是 |
int |
每页数量(默认10,最大1000) |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
list |
object [] |
数据列表 |
receiptId |
long |
订单id |
receiptNo |
string |
单号 |
receiptType |
string |
单据类型 |
receiveName |
string |
收货方 |
planQuantity |
int |
计划数量 |
scanQuantity |
int |
扫描数量 |
receiptDate |
string |
单据日期 |
lines |
object [] |
行数据列表 |
lineNo |
string |
行号 |
lineId |
int |
行id |
planQuantity |
int |
计划数量 |
scanQuantity |
int |
扫描数量 |
total |
int |
总数 |
请求示例
响应示例
{
"code": 200,
"message": "success",
"data": {
"total": 1,
"list": [
{
"receiptId": 123456789,
"receiptNo": "MM-144919-291552",
"receiptType": "销售出库",
"receiveName": "某某公司仓库",
"planQuantity": 1000,
"scanQuantity": 850,
"receiptDate": "2023-10-25",
"lines": [
{
"lineNo": "1",
"lineId":123456789,
"planQuantity": 300,
"scanQuantity": 250
}
]
}
]
}
}
异常示例
订单详情
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/getorder |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
receiptId |
是 |
int |
订单id |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
receiptId |
long |
订单id |
receiptNo |
string |
单号 |
receiptType |
string |
单据类型 |
receiveName |
string |
收货方 |
planQuantity |
int |
计划数量 |
scanQuantity |
int |
扫描数量 |
receiptDate |
string |
单据日期 |
lines |
object [] |
行数据列表 |
lineNo |
string |
行号 |
lineId |
int |
行id |
planQuantity |
int |
计划数量 |
scanQuantity |
int |
扫描数量 |
请求示例
响应示例
{
"code": 200,
"message": "success",
"data": {
"receiptId": 123456789,
"receiptNo": "MM-144919-291552",
"receiptType": "销售出库",
"receiveName": "某某公司仓库",
"planQuantity": 1000,
"scanQuantity": 850,
"receiptDate": "2023-10-25",
"lines": [
{
"lineNo": "1",
"lineId": 123456789,
"planQuantity": 300,
"scanQuantity": 250
}
]
}
}
异常示例
扫描单号
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/scanorder |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
receiptNo |
是 |
string |
单号 |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
响应示例
{
"code": 200,
"message": "success"
}
异常示例
{
"code": 25060001,
"message": "订单已完成"
}
{
"code": 25060002,
"message": "订单被其他用户使用"
}
{
"code": 25060003,
"message": "单号规则错误"
}
{
"code": 25060004,
"message": "跳转到扫描界面",
"data": {
"receiptId": 1234
}
}
新建订单
请求信息
协议 |
HTTPS |
请求方法 |
POST |
请求路径 |
/hivezs/3m/v1/inner/wms/order/create |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
receiptNo |
是 |
string |
单号 |
receiveId |
是 |
int |
收货方 |
lines |
是 |
object [] |
行数据列表 |
lineNo |
是 |
string |
行号 |
planQuantity |
是 |
int |
计划数量 |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
{
"receiptNo": "MM-144919-291552",
"receiveId": 12343,
"lines": [
{
"lineNo": "1",
"planQuantity": 10
}
]
}
响应示例
{
"code": 200,
"message": "success",
"data": {
"receiptId": 1234
}
}
异常示例
获取收货方
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/getreceive |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
receiveId |
long |
收货方id |
receiveNo |
string |
收货方编号 |
receiveName |
string |
收货方名称 |
请求示例
响应示例
{
"code": 200,
"message": "success",
"data": {
"receiveId": 123456789,
"receiveNo": "0001",
"receiveName": "测试经销商"
}
}
异常示例
扫码校验
请求信息
协议 |
HTTPS |
请求方法 |
POST |
请求路径 |
/hivezs/3m/v1/inner/wms/order/checkcode |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
receiptId |
是 |
int |
订单id |
scanMode |
是 |
int |
扫描模式,1 单扫 2 整扫 |
lineId |
是 |
int |
行id |
code |
是 |
string |
箱码 |
deviceNo |
是 |
string |
采集器编号 |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
receiptId |
long |
订单id |
receiptNo |
string |
单号 |
receiptType |
string |
单据类型 |
receiveName |
string |
收货方 |
planQuantity |
int |
计划数量 |
scanQuantity |
int |
扫描数量 |
receiptDate |
string |
单据日期 |
lines |
object [] |
行数据列表 |
lineNo |
string |
行号 |
lineId |
int |
行id |
planQuantity |
int |
计划数量 |
scanQuantity |
int |
扫描数量 |
请求示例
{
"receiptId": 1234,
"scanMode": 1,
"lineId": 12343,
"code": 1234,
"deviceNo":"867854545121212"
}
响应示例
{
"code": 200,
"message": "success",
"data": {
"receiptId": 123456789,
"receiptNo": "MM-144919-291552",
"receiptType": "销售出库",
"receiveName": "某某公司仓库",
"planQuantity": 1000,
"scanQuantity": 850,
"receiptDate": "2023-10-25",
"lines": [
{
"lineNo": "1",
"lineId": 123456789,
"planQuantity": 300,
"scanQuantity": 250
}
]
}
}
异常示例
订单重置
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/reset |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
|
|
|
|
receiptId |
是 |
int |
订单id |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
响应示例
{
"code": 200,
"message": "success"
}
异常示例
按码删除
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/removecode |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
receiptId |
是 |
int |
订单id |
code |
是 |
string |
数码 |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
响应示例
{
"code": 200,
"message": "success"
}
异常示例
{
"code": 25060004,
"message": "数码未扫描"
}
完成订单
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/finish |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
receiptId |
是 |
int |
订单id |
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
响应示例
{
"code": 200,
"message": "success"
}
异常示例
编辑行号
请求信息
协议 |
HTTPS |
请求方法 |
POST |
请求路径 |
/hivezs/3m/v1/inner/wms/order/editline |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
lineNo |
是 |
int |
|
lineId |
是 |
int |
|
planQuantity |
是 |
int |
|
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
{
"lineNo": "1",
"lineId": 123456789,
"planQuantity": 300
}
响应示例
{
"code": 200,
"message": "success"
}
异常示例
删除行号
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/removeline |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
lineId |
是 |
int |
|
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
响应示例
{
"code": 200,
"message": "success"
}
异常示例
重置行号
请求信息
协议 |
HTTPS |
请求方法 |
GET |
请求路径 |
/hivezs/3m/v1/inner/wms/order/resetline |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
lineId |
是 |
int |
|
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
响应示例
{
"code": 200,
"message": "success"
}
异常示例
新增行号
请求信息
协议 |
HTTPS |
请求方法 |
POST |
请求路径 |
/hivezs/3m/v1/inner/wms/order/addline |
请求头 |
Content-Type:application/json |
请求参数
名称 |
是否必须 |
参数类型 |
参数说明 |
receiptId |
是 |
int |
|
lineNo |
是 |
int |
|
planQuantity |
是 |
int |
|
传出参数
名称 |
参数类型 |
参数说明 |
code |
int |
错误码,200:成功,其它为失败 |
message |
string |
|
data |
object |
返回信息 |
请求示例
{
"lineNo": "1",
"planQuantity": 300
}
响应示例
{
"code": 200,
"message": "success"
}