POST Cancel Appointment
POST Cancel appointment
Introduction
Cancels an existing appointment in the Yard Management System (YMS). This endpoint marks the appointment as cancelled and releases any associated resources such as reserved time slots and location assignments. Requires a cancellation reason for audit tracking. Used when carriers cannot fulfill scheduled visits, when customers reschedule operations, or when operational constraints prevent appointment completion. Cancelled appointments remain in the system for historical reporting.
API Request
POST /public/appointment/{appointmentId}/cancel
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 |
body | body | AppointmentCancelCmd | No | none |
Response Example
200 Response
Response
Status Code | Definition | Description | Data Model |
|---|---|---|---|
200 | OK | none | AppointmentView |