POST Search orderIds
Introduction
Search for orders matching specified criteria. Supports filtering by order ID, status, customer, carrier, equipment number, and other fields. Returns a list of all matching order records.
API Request
POST /order/search
Body Request Parameters
{
"currentPage": 0,
"pageSize": 0,
"sortingFields": [
{
"field": "string",
"orderBy": "NONE"
}
],
"orderId": "string",
"orderIds": [
"string"
],
"orderStatus": "string",
"orderStatuses": [
"string"
],
"customerId": "string",
"customerIds": [
"string"
],
"poNo": "string",
"referenceNo": "string",
"referenceNoLike": "string",
"retailer": "string",
"shippedTimePeriod": [
"string"
],
"keyword": "string",
"loadNos": [
"string"
],
"loadNo": "string",
"orPoNo": "string",
"orLoadNo": "string",
"orReferenceNo": "string",
"orBolNo": "string"
}Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| X-Tenant-ID | header | string | No | none |
| X-Yard-ID | header | string | No | none |
| Item-Time-Zone | header | string | No | none |
| Authorization | header | string | No | none |
| body | body | OrderQuery (opens in a new tab) | No | none |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": [
{
"id": 0,
"orderId": "",
"orderStatus": "",
"customerId": "",
"poNo": "",
"referenceNo": "",
"retailer": "",
"shipFrom": "",
"shipTo": "",
"totalPalletQty": 0,
"totalCartonQty": 0,
"itemInfos": [
{
"itemId": "",
"itemName": "",
"itemQty": "",
"palletQty": "",
"itemSpecDesc": "",
"itemSpecName": "",
"uomId": "",
"qty": ""
}
],
"customerName": "",
"carrierName": "",
"shipToAddress": {
"id": "",
"name": "",
"country": "",
"state": "",
"city": "",
"zipCode": "",
"fax": "",
"address1": "",
"address2": "",
"contact": "",
"phone": "",
"extension": "",
"email": "",
"orgId": "",
"orgName": "",
"referenceNo": "",
"batchCode": "",
"storeNo": "",
"shorthand": "",
"toHome": false,
"tags": [
""
],
"latitude": "",
"longitude": "",
"crmAddressId": ""
},
"shipFromAddress": {
"id": "",
"name": "",
"country": "",
"state": "",
"city": "",
"zipCode": "",
"fax": "",
"address1": "",
"address2": "",
"contact": "",
"phone": "",
"extension": "",
"email": "",
"orgId": "",
"orgName": "",
"referenceNo": "",
"batchCode": "",
"storeNo": "",
"shorthand": "",
"toHome": false,
"tags": [
""
],
"latitude": "",
"longitude": "",
"crmAddressId": ""
},
"appointmentTime": "",
"dynamicFieldValues": [
{
"entityId": "",
"entityType": "",
"fieldCode": "",
"value": "",
"fieldName": "",
"longValue": "",
"shortValue": ""
}
],
"proNos": [
""
],
"invoicePros": [
""
],
"doNos": [
""
],
"tripNo": "",
"shippedTime": ""
}
]
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RListOrderView (opens in a new tab) |