POST Paginated Query of Appointment List
Introduction
Searches appointments with pagination support and advanced filtering capabilities. This endpoint allows querying appointments by multiple criteria including date ranges, status, carrier, customer, appointment type, and equipment details. Returns paginated results with configurable page size and sorting options. Used by operations dashboards to display appointment lists, by reporting systems for analytics, and by customer portals for appointment tracking.
API Request
POST /appointment/search-by-paging
Body Request Parameters
{
"currentPage": 0,
"pageSize": 0,
"sortingFields": [
{
"field": "string",
"orderBy": "NONE"
}
],
"appointmentId": "string",
"appointmentIds": [
"string"
],
"appointmentType": "INBOUND",
"appointmentTypes": [
"INBOUND"
],
"carrierId": "string",
"carrierIds": [
"string"
],
"serviceTypes": "Pickup Preload, Live Load, Live Delivery, Drop off Empty, Drop Off Delivery",
"appointmentTimePeriod": [
"string"
],
"appointmentTimeStart": "string",
"appointmentTimeEnd": "string",
"appointmentStatus": "NEW",
"excludeAppointmentStatus": "NEW",
"excludeAppointmentStatuses": [
"NEW"
],
"appointmentStatuses": [
"string"
],
"customerIds": [
"string"
],
"customerId": "string",
"externalId": 0,
"entryId": "string",
"entryIds": [
"string"
],
"referenceCode": "string",
"referenceNo": "string",
"driverId": "string",
"driverIds": [
"string"
],
"receiptId": "string",
"loadId": "string",
"loadNo": "string",
"masterBol": "string",
"poNo": "string",
"orderId": "string",
"keyword": "string",
"createdTimePeriod": [
"string"
],
"reason": "string",
"loadIds": "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 | AppointmentQuery | No | none |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"list": [
{
"id": 0,
"appointmentId": "",
"appointmentType": "",
"carrierId": "",
"carrierName": "",
"finalCarrierId": "",
"subCarrierName": "",
"appointmentTime": "",
"appointmentStatus": "",
"customerIds": [
""
],
"externalId": 0,
"entryId": "",
"referenceCode": "",
"driverId": "",
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"customerNames": [
""
],
"appointmentActionViews": [
{
"id": 0,
"appointmentId": "",
"appointmentType": "",
"serviceType": "",
"appointmentTime": "",
"referenceIds": [
""
],
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"loadViews": [
{
"id": "",
"loadId": "",
"loadStatus": "",
"loadNo": "",
"shipMethod": "",
"carrierId": "",
"appointmentTime": "",
"appointmentId": "",
"orderIds": [
""
],
"customerId": "",
"masterBol": "",
"sealNo": "",
"customerName": "",
"carrierName": "",
"orderViews": [
{
"id": 0,
"orderId": "",
"orderStatus": "",
"customerId": "",
"poNo": "",
"referenceNo": "",
"retailer": "",
"shipFrom": "",
"shipTo": "",
"totalPalletQty": 0,
"totalCartonQty": 0,
"itemInfos": "[Object]",
"customerName": "",
"carrierName": "",
"shipToAddress": "[Object]",
"shipFromAddress": "[Object]",
"appointmentTime": "",
"dynamicFieldValues": "[Object]",
"proNos": "[Object]",
"invoicePros": "[Object]",
"doNos": "[Object]",
"tripNo": "",
"shippedTime": ""
}
],
"dynamicFieldValues": [
{
"entityId": null,
"entityType": null,
"fieldCode": null,
"value": null,
"fieldName": null,
"longValue": null,
"shortValue": null
}
],
"equipmentType": "",
"equipmentNo": "",
"referenceNoList": [
""
],
"poNoList": [
""
],
"templateLoadKey": "",
"proNos": [
""
],
"invoicePros": [
""
],
"doNos": [
""
],
"tripNos": [
""
],
"loadType": "",
"stagingLocationName": "",
"shippedTime": ""
}
],
"receiptViews": [
{
"id": 0,
"receiptId": "",
"receiptStatus": "",
"receiptType": "",
"poNo": "",
"carrierId": "",
"customerId": "",
"referenceNo": "",
"equipmentType": "",
"equipmentNo": "",
"totalPalletQty": 0,
"itemLines": [
{
"itemId": null,
"itemName": null,
"itemQty": null,
"palletQty": null,
"itemSpecDesc": null,
"itemSpecName": null,
"uomId": null,
"qty": null
}
],
"appointmentTime": "",
"appointmentId": "",
"sealNo": "",
"dataChannel": "",
"eventTime": "",
"extraData": "",
"carrierName": "",
"customerName": "",
"dynamicFieldValues": [
{
"entityId": null,
"entityType": null,
"fieldCode": null,
"value": null,
"fieldName": null,
"longValue": null,
"shortValue": null
}
],
"proNos": [
""
],
"invoicePros": [
""
],
"doNos": [
""
],
"tripNo": ""
}
]
}
],
"driverSnapshot": "",
"driverSnapshotParse": {
"driverId": "",
"firstName": "",
"middleName": "",
"lastName": "",
"driverPhone": "",
"phone": "",
"licenseNumber": "",
"licenseExpirationDate": "",
"licenseState": "",
"email": "",
"licensePlate": "",
"carrierName": "",
"carrierId": "",
"usdot": "",
"equipmentNo": "",
"equipmentType": "",
"cargoStatus": ""
},
"serviceTypes": [
""
],
"checkedInTime": "",
"carrierFinishTime": "",
"driverFinishTime": "",
"finalCarrierView": {
"carrierId": "",
"carrierName": "",
"scac": [
""
],
"usdot": "",
"mcNumber": "",
"verified": false,
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"carrierStatus": "",
"knownName": "",
"orgIds": [
""
]
},
"cargoStatus": "",
"notes": ""
}
],
"totalCount": 0,
"currentPage": 0,
"pageSize": 0,
"totalPage": 0
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RPageResultAppointmentView |