POST Update Appointment Information
POST Update Appointment Information
Introduction
Updates an existing appointment's details in the Yard Management System (YMS). This endpoint allows modifications to appointment time, carrier assignment, customer associations, and action details. Supports change tracking with reason codes for audit purposes. Used when appointments need rescheduling, carrier reassignment, or service type modifications. The system validates new time slot availability and ensures changes comply with operational constraints before applying updates.
API Request
POST /public/appointment/{appointmentId}/update
Body Request Parameters
Request Parameters
Name | Location | Type | Required | Description |
|---|---|---|---|---|
appointmentId | path | string | Yes | Appointment ID |
X-Tenant-ID | header | string | No | none |
X-Yard-ID | header | string | No | none |
Item-Time-Zone | header | string | No | none |
Authorization | header | string | No | none |
Item-Bam-Client | header | string | No | none |
x-facility-id | header | string | No | none |
body | body | object | No | none |
» appointmentTime | body | string | Yes | Updated appointment time |
» carrierId | body | string | Yes | Updated carrier identifier |
» externalCarrierId | body | string | No | External carrier identifier from external systems |
» customerIds | body | [string] | No | Updated list of customer identifiers |
» change | body | AppointmentChangeCreateCmd | Yes | Change record for tracking modifications |
»» appointmentId | body | string | Yes | Appointment identifier |
»» changeType | body | string | No | Type of change made |
»» appointmentTimeFrom | body | string | No | Original appointment time |
»» appointmentTimeTo | body | string | No | New appointment time |
»» missAppointment | body | boolean | No | Flag indicating if appointment time was missed |
»» note | body | string | No | Additional notes or comments |
»» reason | body | string | No | Reason for the change |
»» receiptIds | body | [string] | No | Current receipt IDs |
»» loadIds | body | [string] | No | Current load IDs |
»» originalInboundAction | body | string | No | Original inbound action |
»» originalReceiptIds | body | [string] | No | Original receipt IDs |
»» originalOutboundAction | body | string | No | Original outbound action |
»» originalLoadIds | body | [string] | No | Original load IDs |
»» nowInboundAction | body | string | No | Current inbound action at the time of change |
»» nowOutboundAction | body | string | No | Current outbound action at the time of change |
» inboundAction | body | AppointmentActionCreateCmd | No | Updated inbound action details |
»» appointmentId | body | string | No | Appointment identifier |
»» appointmentType | body | string | Yes | Type of appointment action |
»» serviceType | body | string | Yes | Service type for the action |
»» appointmentTime | body | string | No | Scheduled time for the action |
»» referenceIds | body | [string] | No | List of reference numbers |
»» customerIds | body | [string] | No | List of customer identifiers |
» outboundAction | body | AppointmentActionCreateCmd | No | Updated outbound action details |
»» appointmentId | body | string | No | Appointment identifier |
»» appointmentType | body | string | Yes | Type of appointment action |
»» serviceType | body | string | Yes | Service type for the action |
»» appointmentTime | body | string | No | Scheduled time for the action |
»» referenceIds | body | [string] | No | List of reference numbers |
»» customerIds | body | [string] | No | List of customer identifiers |
» updateAction | body | boolean | Yes | Flag to indicate whether to update action records |
» finalCarrierId | body | string | No | Sub-carrier identifier |
» driverId | body | string | No | Driver identifier |
» carrierReference | body | string | No | Carrier reference number |
» carrierNotes | body | string | No | Carrier notes or comments |
» cargoStatus | body | string | No | Cargo status |
» notes | body | string | No | Note or remarks for the appointment |
» operator | body | string | No | Operator who updates the appointment (carrier, customer, or internal). Not persisted to database. |
Enum Values
Property | Value |
|---|---|
»» changeType | UPDATE |
»» changeType | CANCEL |
»» changeType | ASSIGN_DRIVER |
»» changeType | COMPLETEPRECHECK_IN |
»» changeType | COMPLETECHECKIN |
»» appointmentType | INBOUND |
»» appointmentType | OUTBOUND |
»» appointmentType | BOTH |
»» appointmentType | INBOUND |
»» appointmentType | OUTBOUND |
»» appointmentType | BOTH |
» cargoStatus | UNKNOWN |
» cargoStatus | FULL |
» cargoStatus | EMPTY |
» cargoStatus | FULLAFTERLOADED |
» cargoStatus | EMPTYAFTEROFFLOAD |
» operator | CARRIER |
» operator | CUSTOMER |
» operator | INTERNAL |
Response Example
200 Response
Response
Status Code | Definition | Description | Data Model |
|---|---|---|---|
200 | OK | none | RAppointmentView |