Appointment
You can use this PATCH API request to update the following fields on the Appointment UI.
URL
PATCH.../wms/lgfapi/v10/entity/appointment/{id}/
Request Parameters/Fields
| Parameter/Field Name | Type | Format/Comments |
| preferred_dock_id | Integer | |
| planned_start_ts | Datetime | YYYY-MM-DDTHH:MM:SS |
| arrived_ts | Datetime | YYYY-MM-DDTHH:MM:SS |
| duration | Integer | |
| estimated_units | Float | |
| carrier_info | String | |
| cust_reference_text | String | |
| cust_field_1 | String | This field supports up to a maximum of 1000 characters. If you pass a custom field value more than 1000 characters, the API fails. |
| cust_field_2 | String | This field supports up to a maximum of 1000 characters. If you pass a custom field value more than 1000 characters, the API fails. |
| cust_field_3 | String | This field supports up to a maximum of 1000 characters. If you pass a custom field value more than 1000 characters, the API fails. |
| cust_field_4 | String | This field supports up to a maximum of 1000 characters. If you pass a custom field value more than 1000 characters, the API fails. |
| cust_field_5 | String | This field supports up to a maximum of 1000 characters. If you pass a custom field value more than 1000 characters, the API fails. |
Request Body
{
"fields":
{
"preferred_dock_id" : 147,
"planned_start_ts": "2020-02-28T12:12:12",
"arrived_ts" : "2020-02-28T12:12:12",
"duration" : 37,
"estimated_units" : 12,
"carrier_info": "Carrier01",
"cust_reference_text" : "check-in the appt",
"cust_field_1": "XXXXX1",
"cust_field_2": "XXXXX2",
"cust_field_3": "XXXXX3",
"cust_field_4": "XXXXX4",
"cust_field_5": "XXXXX5"
}
}
Sample Response
200 OK