GET Get Appointment Details
Introduction
Retrieves detailed information for a specific appointment by its unique identifier. This endpoint returns comprehensive appointment data including scheduled times, carrier and customer details, inbound/outbound actions, current status, and associated equipment information. Used by operations staff to view appointment details, by gate personnel to verify scheduled visits, and by customer-facing applications to display booking information.
API Request
GET /appointment/{appointmentId}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| appointmentId | path | string | Yes | Appointment ID |
| 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 |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"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": [
{
"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": ""
}
],
"dynamicFieldValues": [
{
"entityId": "",
"entityType": "",
"fieldCode": "",
"value": "",
"fieldName": "",
"longValue": "",
"shortValue": ""
}
],
"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": "",
"itemName": "",
"itemQty": "",
"palletQty": "",
"itemSpecDesc": "",
"itemSpecName": "",
"uomId": "",
"qty": ""
}
],
"appointmentTime": "",
"appointmentId": "",
"sealNo": "",
"dataChannel": "",
"eventTime": "",
"extraData": "",
"carrierName": "",
"customerName": "",
"dynamicFieldValues": [
{
"entityId": "",
"entityType": "",
"fieldCode": "",
"value": "",
"fieldName": "",
"longValue": "",
"shortValue": ""
}
],
"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": ""
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RAppointmentView |