skyouc
2024-12-21 c635d78b479510ebe2556a420948effcd30a0731
zy-asrs-openapi/src/main/webapp/views/md/getOrderList.md
@@ -1,165 +1,165 @@
## 获取订单列表
- **接口说明:** 获取订单列表
- **接口地址:** /api/getOrderList
#### 请求参数
参数名称                  |类型      |出现要求   |描述
:----                  |:---      |:------   |:---
Header                  |       |必填         |请求报文头
 appkey               |string      |必填         |密钥管理中生成appkey
Body                  |       |         | 
 orderNo            |string      |可选         |订单号
 orderType            |int      |可选         |订单类型
 status            |int      |可选         |订单状态
请求示例:
```
{
    "orderNo": "2024010311062544",
    "orderType": 7,
    "status": 1
}
```
#### 返回结果
参数名称                  |类型      |出现要求   |描述
:----                  |:---      |:------   |:---
code                  |int      |必填         |响应码,代码定义请见“附录A 响应吗说明”
msg                     |string      |必填         | 
data                  |object      |可选         | 
示例:
```
{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "order": {
                "id": 16,
                "uuid": "1192870598489931776",
                "orderNo": "2024010311062544",
                "orderTime": "2024-01-05 16:41:53",
                "docType": 7,
                "itemId": null,
                "itemName": null,
                "allotItemId": null,
                "defNumber": null,
                "number": null,
                "cstmr": null,
                "cstmrName": null,
                "tel": null,
                "operMemb": null,
                "totalFee": null,
                "discount": null,
                "discountFee": null,
                "otherFee": null,
                "actFee": null,
                "payType": null,
                "salesman": null,
                "accountDay": null,
                "postFeeType": null,
                "postFee": null,
                "payTime": null,
                "sendTime": null,
                "shipName": null,
                "shipCode": null,
                "settle": 1,
                "status": 1,
                "createBy": 9527,
                "createTime": "2024-01-05T08:41:53.143+00:00",
                "updateBy": 9527,
                "updateTime": "2024-01-05T08:41:53.143+00:00",
                "memo": null,
                "hostId": 1,
                "hostId$": "中扬储存设备",
                "createTime$": "2024-01-05 16:41:53",
                "status$": "正常",
                "updateTime$": "2024-01-05 16:41:53",
                "updateBy$": null,
                "createBy$": null,
                "allotItemId$": null,
                "cstmr$": null,
                "payTime$": "",
                "payType$": null,
                "sendTime$": "",
                "postFeeType$": null,
                "itemId$": null,
                "docType$": "销售出库",
                "settle$": "待处理"
            },
            "orderDetls": [
                {
                    "id": 30,
                    "orderId": 16,
                    "orderNo": "2024010311062544",
                    "anfme": 10,
                    "qty": 0,
                    "matnr": "test001",
                    "maktx": "测试物料1",
                    "batch": "",
                    "specs": null,
                    "model": null,
                    "color": null,
                    "brand": null,
                    "unit": null,
                    "price": null,
                    "sku": null,
                    "units": null,
                    "barcode": null,
                    "origin": null,
                    "manu": null,
                    "manuDate": null,
                    "itemNum": null,
                    "safeQty": null,
                    "weight": null,
                    "length": null,
                    "volume": null,
                    "threeCode": null,
                    "supp": null,
                    "suppCode": null,
                    "beBatch": null,
                    "deadTime": null,
                    "deadWarn": null,
                    "source": null,
                    "inspect": null,
                    "danger": null,
                    "status": 1,
                    "createBy": 9527,
                    "createTime": "2024-01-05T08:41:53.143+00:00",
                    "updateBy": 9527,
                    "updateTime": "2024-01-05T08:41:53.143+00:00",
                    "memo": null,
                    "hostId": 1,
                    "enableQty": 10,
                    "hostId$": "中扬储存设备",
                    "createTime$": "2024-01-05 16:41:53",
                    "status$": "正常",
                    "updateTime$": "2024-01-05 16:41:53",
                    "updateBy$": null,
                    "createBy$": null,
                    "beBatch$": null,
                    "danger$": null,
                    "source$": null,
                    "orderId$": "16",
                    "inspect$": null
                }
            ]
        }
    ]
}
```
## 附录A 响应码说明
响应码   |说明
:----   |:---
200      |处理成功
## 获取订单列表
- **接口说明:** 获取订单列表
- **接口地址:** /api/getOrderList
#### 请求参数
参数名称                  |类型      |出现要求   |描述
:----                  |:---      |:------   |:---
Header                  |       |必填         |请求报文头
 appkey               |string      |必填         |密钥管理中生成appkey
Body                  |       |         | 
 orderNo            |string      |可选         |订单号
 orderType            |int      |可选         |订单类型
 status            |int      |可选         |订单状态
请求示例:
```
{
    "orderNo": "2024010311062544",
    "orderType": 7,
    "status": 1
}
```
#### 返回结果
参数名称                  |类型      |出现要求   |描述
:----                  |:---      |:------   |:---
code                  |int      |必填         |响应码,代码定义请见“附录A 响应吗说明”
msg                     |string      |必填         | 
data                  |object      |可选         | 
示例:
```
{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "order": {
                "id": 16,
                "uuid": "1192870598489931776",
                "orderNo": "2024010311062544",
                "orderTime": "2024-01-05 16:41:53",
                "docType": 7,
                "itemId": null,
                "itemName": null,
                "allotItemId": null,
                "defNumber": null,
                "number": null,
                "cstmr": null,
                "cstmrName": null,
                "tel": null,
                "operMemb": null,
                "totalFee": null,
                "discount": null,
                "discountFee": null,
                "otherFee": null,
                "actFee": null,
                "payType": null,
                "salesman": null,
                "accountDay": null,
                "postFeeType": null,
                "postFee": null,
                "payTime": null,
                "sendTime": null,
                "shipName": null,
                "shipCode": null,
                "settle": 1,
                "status": 1,
                "createBy": 9527,
                "createTime": "2024-01-05T08:41:53.143+00:00",
                "updateBy": 9527,
                "updateTime": "2024-01-05T08:41:53.143+00:00",
                "memo": null,
                "hostId": 1,
                "hostId$": "中扬储存设备",
                "createTime$": "2024-01-05 16:41:53",
                "status$": "正常",
                "updateTime$": "2024-01-05 16:41:53",
                "updateBy$": null,
                "createBy$": null,
                "allotItemId$": null,
                "cstmr$": null,
                "payTime$": "",
                "payType$": null,
                "sendTime$": "",
                "postFeeType$": null,
                "itemId$": null,
                "docType$": "销售出库",
                "settle$": "待处理"
            },
            "orderDetls": [
                {
                    "id": 30,
                    "orderId": 16,
                    "orderNo": "2024010311062544",
                    "anfme": 10,
                    "qty": 0,
                    "matnr": "test001",
                    "maktx": "测试物料1",
                    "batch": "",
                    "specs": null,
                    "model": null,
                    "color": null,
                    "brand": null,
                    "unit": null,
                    "price": null,
                    "sku": null,
                    "units": null,
                    "barcode": null,
                    "origin": null,
                    "manu": null,
                    "manuDate": null,
                    "itemNum": null,
                    "safeQty": null,
                    "weight": null,
                    "length": null,
                    "volume": null,
                    "threeCode": null,
                    "supp": null,
                    "suppCode": null,
                    "beBatch": null,
                    "deadTime": null,
                    "deadWarn": null,
                    "source": null,
                    "inspect": null,
                    "danger": null,
                    "status": 1,
                    "createBy": 9527,
                    "createTime": "2024-01-05T08:41:53.143+00:00",
                    "updateBy": 9527,
                    "updateTime": "2024-01-05T08:41:53.143+00:00",
                    "memo": null,
                    "hostId": 1,
                    "enableQty": 10,
                    "hostId$": "中扬储存设备",
                    "createTime$": "2024-01-05 16:41:53",
                    "status$": "正常",
                    "updateTime$": "2024-01-05 16:41:53",
                    "updateBy$": null,
                    "createBy$": null,
                    "beBatch$": null,
                    "danger$": null,
                    "source$": null,
                    "orderId$": "16",
                    "inspect$": null
                }
            ]
        }
    ]
}
```
## 附录A 响应码说明
响应码   |说明
:----   |:---
200      |处理成功
500      |系统内部错误