AppointmentView
{
"id": 0,
"appointmentId": "string",
"appointmentType": "INBOUND",
"carrierId": "string",
"carrierName": "string",
"finalCarrierId": "string",
"subCarrierName": "string",
"appointmentTime": "string",
"appointmentStatus": "NEW",
"customerIds": [
"string"
],
"externalId": 0,
"entryId": "string",
"referenceCode": "string",
"driverId": "string",
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string",
"customerNames": [
"string"
],
"appointmentActionViews": [
{
"id": 0,
"appointmentId": "string",
"appointmentType": "INBOUND",
"serviceType": "string",
"appointmentTime": "string",
"referenceIds": [
"string"
],
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string",
"loadViews": [
{
"id": "string",
"loadId": "LOAD-12345",
"loadStatus": "string",
"loadNo": "string",
"shipMethod": "string",
"carrierId": "string",
"appointmentTime": "2025-08-08T10:00:00",
"appointmentId": "string",
"orderIds": [
"string"
],
"customerId": "string",
"masterBol": "string",
"sealNo": "123456",
"customerName": "string",
"carrierName": "string",
"orderViews": [
{}
],
"dynamicFieldValues": [
{}
],
"equipmentType": "TRAILER",
"equipmentNo": "string",
"referenceNoList": [
"string"
],
"poNoList": [
"string"
],
"templateLoadKey": "string",
"proNos": [
"string"
],
"invoicePros": [
"string"
],
"doNos": [
"string"
],
"tripNos": [
"string"
],
"loadType": "string",
"stagingLocationName": "string",
"shippedTime": "string"
}
],
"receiptViews": [
{
"id": 0,
"receiptId": "string",
"receiptStatus": "string",
"receiptType": "string",
"poNo": "string",
"carrierId": "string",
"customerId": "string",
"referenceNo": "string",
"equipmentType": "string",
"equipmentNo": "string",
"totalPalletQty": 0,
"itemLines": [
{}
],
"appointmentTime": "string",
"appointmentId": "string",
"sealNo": "string",
"dataChannel": "YMS",
"eventTime": "string",
"extraData": "string",
"carrierName": "string",
"customerName": "string",
"dynamicFieldValues": [
{}
],
"proNos": [
"string"
],
"invoicePros": [
"string"
],
"doNos": [
"string"
],
"tripNo": "string"
}
]
}
],
"driverSnapshot": "string",
"driverSnapshotParse": {
"driverId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"driverPhone": "string",
"phone": "string",
"licenseNumber": "string",
"licenseExpirationDate": "string",
"licenseState": "string",
"email": "string",
"licensePlate": "ABC123",
"carrierName": "string",
"carrierId": "string",
"usdot": "string",
"equipmentNo": "string",
"equipmentType": "VEHICLE",
"cargoStatus": "UNKNOWN"
},
"serviceTypes": [
"string"
],
"checkedInTime": "string",
"carrierFinishTime": "string",
"driverFinishTime": "string",
"finalCarrierView": {
"carrierId": "string",
"carrierName": "string",
"scac": [
"string"
],
"usdot": "string",
"mcNumber": "string",
"verified": true,
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string",
"carrierStatus": "ACTIVE,INACTIVE,EXCEPTION",
"knownName": "string",
"orgIds": [
"string"
]
},
"cargoStatus": "UNKNOWN",
"notes": "string"
}
Properties
| Name | Type | Required | Constraints | Chinese Name | Description |
|---|---|---|---|---|---|
| id | integer(int64) | false | none | Internal database ID | |
| appointmentId | string | false | none | Unique appointment identifier | |
| appointmentType | string | false | none | Type of appointment | |
| carrierId | string | false | none | Carrier identifier | |
| carrierName | string | false | none | Carrier name | |
| finalCarrierId | string | false | none | Sub-carrier identifier | |
| subCarrierName | string | false | none | Sub-carrier name | |
| appointmentTime | string | false | none | Scheduled appointment time | |
| appointmentStatus | string | false | none | Current appointment status | |
| customerIds | [string] | false | none | List of customer identifiers | |
| externalId | integer(int64) | false | none | External system identifier | |
| entryId | string | false | none | Entry ticket identifier | |
| referenceCode | string | false | none | 6-digit reference code for check-in binding | |
| driverId | string | false | none | Driver identifier | |
| createdTime | string | false | none | Record creation timestamp | |
| createdBy | string | false | none | User who created the record | |
| updatedTime | string | false | none | Record last update timestamp | |
| updatedBy | string | false | none | User who last updated the record | |
| customerNames | [string] | false | none | List of customer names | |
| appointmentActionViews | [AppointmentActionView (opens in a new tab)] | false | none | List of appointment action views | |
| driverSnapshot | string | false | none | Driver information snapshot | |
| driverSnapshotParse | DriverSnapshot (opens in a new tab) | false | none | Driver information snapshot (parsed object) | |
| serviceTypes | [string] | false | none | List of service types | |
| checkedInTime | string | false | none | Actual check-in timestamp | |
| carrierFinishTime | string | false | none | Time when carrier finished filling driver info and SMS was sent | |
| driverFinishTime | string | false | none | Time when driver finished pre check-in and QR code was generated | |
| finalCarrierView | CarrierView (opens in a new tab) | false | none | Sub-carrier detailed information | |
| cargoStatus | string | false | none | Cargo status | |
| notes | string | false | none | Note or remarks for the appointment |
Enum Values
| Property | Value |
|---|---|
| appointmentType | INBOUND |
| appointmentType | OUTBOUND |
| appointmentType | BOTH |
| appointmentStatus | NEW |
| appointmentStatus | CANCELED |
| appointmentStatus | NOT_CONFIRMED |
| appointmentStatus | PENDING_DISPATCH |
| appointmentStatus | WAITING_FOR_DRIVER |
| appointmentStatus | PRE_CHECK_IN_COMPLETE |
| appointmentStatus | CHECKED_IN |
| cargoStatus | UNKNOWN |
| cargoStatus | FULL |
| cargoStatus | EMPTY |
| cargoStatus | FULL_AFTER_LOADED |
| cargoStatus | EMPTY_AFTER_OFFLOAD |