API Docs
YMS API
Data Models
Appointment
Appointment Update CMD

AppointmentUpdateCmd

{
  "appointmentTime": "string",
  "carrierId": "string",
  "customerIds": [
    "string"
  ],
  "change": {
    "appointmentId": "string",
    "changeType": "UPDATE",
    "appointmentTimeFrom": "string",
    "appointmentTimeTo": "string",
    "missAppointment": true,
    "note": "string",
    "reason": "string",
    "receiptIds": [
      "string"
    ],
    "loadIds": [
      "string"
    ],
    "originalInboundAction": "string",
    "originalReceiptIds": [
      "string"
    ],
    "originalOutboundAction": "string",
    "originalLoadIds": [
      "string"
    ],
    "nowInboundAction": "string",
    "nowOutboundAction": "string"
  },
  "inboundAction": {
    "appointmentId": "string",
    "appointmentType": "INBOUND",
    "serviceType": "string",
    "appointmentTime": "string",
    "referenceIds": [
      "string"
    ],
    "customerIds": [
      "string"
    ]
  },
  "outboundAction": {
    "appointmentId": "string",
    "appointmentType": "INBOUND",
    "serviceType": "string",
    "appointmentTime": "string",
    "referenceIds": [
      "string"
    ],
    "customerIds": [
      "string"
    ]
  },
  "updateAction": true,
  "finalCarrierId": "string",
  "driverId": "string",
  "carrierReference": "string",
  "carrierNotes": "string",
  "cargoStatus": "UNKNOWN",
  "notes": "string",
  "operator": "CARRIER"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
appointmentTimestringtruenoneUpdated appointment time
carrierIdstringtruenoneUpdated carrier identifier
customerIds[string]falsenoneUpdated list of customer identifiers
changeAppointmentChangeCreateCmd (opens in a new tab)falsenoneChange record for tracking modifications
inboundActionAppointmentActionCreateCmd (opens in a new tab)falsenoneUpdated inbound action details
outboundActionAppointmentActionCreateCmd (opens in a new tab)falsenoneUpdated outbound action details
updateActionbooleanfalsenoneFlag to indicate whether to update action records
finalCarrierIdstringfalsenoneSub-carrier identifier
driverIdstringfalsenoneDriver identifier
carrierReferencestringfalsenoneCarrier reference number
carrierNotesstringfalsenoneCarrier notes or comments
cargoStatusstringfalsenoneCargo status
notesstringfalsenoneNote or remarks for the appointment
operatorstringfalsenoneOperator who updates the appointment (carrier, customer, or internal). Not persisted to database.

Enum Values

PropertyValue
cargoStatusUNKNOWN
cargoStatusFULL
cargoStatusEMPTY
cargoStatusFULL_AFTER_LOADED
cargoStatusEMPTY_AFTER_OFFLOAD
operatorCARRIER
operatorCUSTOMER
operatorINTERNAL