Item Logo
Yms apiData modelsAppointment

Appointment Create CMD

AppointmentCreateCmd

Properties

Name

Type

Required

Constraints

Chinese Name

Description

appointmentTime

string

true

none


Scheduled appointment time

carrierId

string

true

none


Carrier identifier

customerIds

[string]

false

none


List of customer identifiers

inboundAction

AppointmentActionCreateCmd

false

none


Inbound action details, only present when appointmentType is INBOUND or BOTH

outboundAction

AppointmentActionCreateCmd

false

none


Outbound action details, only present when appointmentType is OUTBOUND or BOTH

appointmentType

string

false

none


Appointment type

notes

string

false

none


Note or remarks for the appointment

operator

string

false

none


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

Enum Values

Property

Value

appointmentType

INBOUND

appointmentType

OUTBOUND

appointmentType

BOTH

operator

CARRIER

operator

CUSTOMER

operator

INTERNAL