Appointment View
AppointmentView
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] | false | none | List of appointment action views | |
driverSnapshot | string | false | none | Driver information snapshot | |
driverSnapshotParse | DriverSnapshot | 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 | 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 | WAITINGFORDRIVER |
appointmentStatus | PRECHECKIN_COMPLETE |
appointmentStatus | CHECKED_IN |
cargoStatus | UNKNOWN |
cargoStatus | FULL |
cargoStatus | EMPTY |
cargoStatus | FULLAFTERLOADED |
cargoStatus | EMPTYAFTEROFFLOAD |