Item Logo
Yms apiData modelsAppointment

Appointment Update CMD

AppointmentUpdateCmd

Properties

Name

Type

Required

Constraints

Chinese Name

Description

appointmentTime

string

true

none


Updated appointment time

carrierId

string

true

none


Updated carrier identifier

customerIds

[string]

false

none


Updated list of customer identifiers

change

AppointmentChangeCreateCmd

false

none


Change record for tracking modifications

inboundAction

AppointmentActionCreateCmd

false

none


Updated inbound action details

outboundAction

AppointmentActionCreateCmd

false

none


Updated outbound action details

updateAction

boolean

false

none


Flag to indicate whether to update action records

finalCarrierId

string

false

none


Sub-carrier identifier

driverId

string

false

none


Driver identifier

carrierReference

string

false

none


Carrier reference number

carrierNotes

string

false

none


Carrier notes or comments

cargoStatus

string

false

none


Cargo status

notes

string

false

none


Note or remarks for the appointment

operator

string

false

none


Operator who updates the appointment (carrier, customer, or internal). Not persisted to database.

Enum Values

Property

Value

cargoStatus

UNKNOWN

cargoStatus

FULL

cargoStatus

EMPTY

cargoStatus

FULLAFTERLOADED

cargoStatus

EMPTYAFTEROFFLOAD

operator

CARRIER

operator

CUSTOMER

operator

INTERNAL