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 /appointment/{appointmentId}/update
Body Request Parameters
{
"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"
}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 | AppointmentUpdateCmd | No | none |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"id": 0,
"appointmentId": "",
"appointmentType": "",
"carrierId": "",
"carrierName": "",
"finalCarrierId": "",
"subCarrierName": "",
"appointmentTime": "",
"appointmentStatus": "",
"customerIds": [
""
],
"externalId": 0,
"entryId": "",
"referenceCode": "",
"driverId": "",
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"customerNames": [
""
],
"appointmentActionViews": [
{
"id": 0,
"appointmentId": "",
"appointmentType": "",
"serviceType": "",
"appointmentTime": "",
"referenceIds": [
""
],
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"loadViews": [
{
"id": "",
"loadId": "",
"loadStatus": "",
"loadNo": "",
"shipMethod": "",
"carrierId": "",
"appointmentTime": "",
"appointmentId": "",
"orderIds": [
""
],
"customerId": "",
"masterBol": "",
"sealNo": "",
"customerName": "",
"carrierName": "",
"orderViews": [
{
"id": 0,
"orderId": "",
"orderStatus": "",
"customerId": "",
"poNo": "",
"referenceNo": "",
"retailer": "",
"shipFrom": "",
"shipTo": "",
"totalPalletQty": 0,
"totalCartonQty": 0,
"itemInfos": [
{
"itemId": "",
"itemName": "",
"itemQty": "",
"palletQty": "",
"itemSpecDesc": "",
"itemSpecName": "",
"uomId": "",
"qty": ""
}
],
"customerName": "",
"carrierName": "",
"shipToAddress": {
"id": "",
"name": "",
"country": "",
"state": "",
"city": "",
"zipCode": "",
"fax": "",
"address1": "",
"address2": "",
"contact": "",
"phone": "",
"extension": "",
"email": "",
"orgId": "",
"orgName": "",
"referenceNo": "",
"batchCode": "",
"storeNo": "",
"shorthand": "",
"toHome": false,
"tags": [
""
],
"latitude": "",
"longitude": "",
"crmAddressId": ""
},
"shipFromAddress": {
"id": "",
"name": "",
"country": "",
"state": "",
"city": "",
"zipCode": "",
"fax": "",
"address1": "",
"address2": "",
"contact": "",
"phone": "",
"extension": "",
"email": "",
"orgId": "",
"orgName": "",
"referenceNo": "",
"batchCode": "",
"storeNo": "",
"shorthand": "",
"toHome": false,
"tags": [
""
],
"latitude": "",
"longitude": "",
"crmAddressId": ""
},
"appointmentTime": "",
"dynamicFieldValues": [
{
"entityId": "",
"entityType": "",
"fieldCode": "",
"value": "",
"fieldName": "",
"longValue": "",
"shortValue": ""
}
],
"proNos": [
""
],
"invoicePros": [
""
],
"doNos": [
""
],
"tripNo": "",
"shippedTime": ""
}
],
"dynamicFieldValues": [
{
"entityId": "",
"entityType": "",
"fieldCode": "",
"value": "",
"fieldName": "",
"longValue": "",
"shortValue": ""
}
],
"equipmentType": "",
"equipmentNo": "",
"referenceNoList": [
""
],
"poNoList": [
""
],
"templateLoadKey": "",
"proNos": [
""
],
"invoicePros": [
""
],
"doNos": [
""
],
"tripNos": [
""
],
"loadType": "",
"stagingLocationName": "",
"shippedTime": ""
}
],
"receiptViews": [
{
"id": 0,
"receiptId": "",
"receiptStatus": "",
"receiptType": "",
"poNo": "",
"carrierId": "",
"customerId": "",
"referenceNo": "",
"equipmentType": "",
"equipmentNo": "",
"totalPalletQty": 0,
"itemLines": [
{
"itemId": "",
"itemName": "",
"itemQty": "",
"palletQty": "",
"itemSpecDesc": "",
"itemSpecName": "",
"uomId": "",
"qty": ""
}
],
"appointmentTime": "",
"appointmentId": "",
"sealNo": "",
"dataChannel": "",
"eventTime": "",
"extraData": "",
"carrierName": "",
"customerName": "",
"dynamicFieldValues": [
{
"entityId": "",
"entityType": "",
"fieldCode": "",
"value": "",
"fieldName": "",
"longValue": "",
"shortValue": ""
}
],
"proNos": [
""
],
"invoicePros": [
""
],
"doNos": [
""
],
"tripNo": ""
}
]
}
],
"driverSnapshot": "",
"driverSnapshotParse": {
"driverId": "",
"firstName": "",
"middleName": "",
"lastName": "",
"driverPhone": "",
"phone": "",
"licenseNumber": "",
"licenseExpirationDate": "",
"licenseState": "",
"email": "",
"licensePlate": "",
"carrierName": "",
"carrierId": "",
"usdot": "",
"equipmentNo": "",
"equipmentType": "",
"cargoStatus": ""
},
"serviceTypes": [
""
],
"checkedInTime": "",
"carrierFinishTime": "",
"driverFinishTime": "",
"finalCarrierView": {
"carrierId": "",
"carrierName": "",
"scac": [
""
],
"usdot": "",
"mcNumber": "",
"verified": false,
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": "",
"carrierStatus": "",
"knownName": "",
"orgIds": [
""
]
},
"cargoStatus": "",
"notes": ""
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RAppointmentView |