Dock Scheduling events
appointment.created
Example
{
"name":"Hold the Door",
"reason":"OTHER",
"reference_id":"123456789",
"description":"Some description",
"is_all_day":false,
"matched_load_type_id":"01HC0PNG8TX8YK26A14DXC0VVS",
"references":[
{
"qualifier":"SHIPMENT_REFERENCE_ID",
"value":"RFS2QT"
},
{
"qualifier":"BOL_NUMBER",
"value":"SW2305474"
},
{
"qualifier":"PRO_NUMBER",
"value":"PRO#22232"
},
{
"qualifier":"CUSTOMER_REFERENCE_NUMBER",
"value":"CRN#777"
}
],
"start":{
"timestamp":"2023-10-08T10:57:35.396466-05:00",
"timezone":"America/Chicago"
},
"end":{
"timestamp":"2023-10-08T11:40:35.396466-05:00",
"timezone":"America/Chicago"
},
"stop_id":"10a53037-802e-4569-a5f4-5e52b51125bd",
"carrier_name":"Planet Express",
"carrier_contact":"Philip J. Fry",
"carrier_tenant_id":"ed4cb32a-3371-4a02-a715-319d531bd73c",
"driver_id":"ba37357a-1187-4a9b-bfe7-b049407e8b0f",
"appointment_type":"BY_APPOINTMENT_ONLY",
"delivery_type":"RECEIVING",
"scheduled_resource_type":"SHIPMENT",
"scheduled_resource_id":"d417832f-3e6a-45f8-b329-2534172face4",
"scheduled_resource_metadata":{
"resource_type":"SHIPMENT",
"shipment_id":"d417832f-3e6a-45f8-b329-2534172face4",
"planned_date":null
},
"id":"01HC0PNGHW7AB0CEH5MNYPPPGE",
"facility_id":"01HC0PNG7VRD8PB4RXT066Z644",
"dock_id":"01HC0PNG8NJXE0EXF0SF1PZ7JJ",
"status":"SCHEDULED",
"is_closed":false,
"created_by":"bcde6f10-0ce3-4d0b-9b8a-8a1b90841128",
"deleted_by":null,
"checked_in_at":null,
"checked_in_by_user_id":null,
"checked_out_at":null,
"checked_out_by_user_id":null,
"rejected_at":null,
"rejected_reasons":null,
"scheduled_resource_reference_id":"RFS2QT"
}
appointment.scheduled
Example
{
"name":"Hold the Door",
"reason":"OTHER",
"reference_id":"123456789",
"description":"Some description",
"is_all_day":false,
"matched_load_type_id":"01HC0PNG8TX8YK26A14DXC0VVS",
"references":[
{
"qualifier":"SHIPMENT_REFERENCE_ID",
"value":"RFS2QT"
},
{
"qualifier":"BOL_NUMBER",
"value":"SW2305474"
},
{
"qualifier":"PRO_NUMBER",
"value":"PRO#22232"
},
{
"qualifier":"CUSTOMER_REFERENCE_NUMBER",
"value":"CRN#777"
}
],
"start":{
"timestamp":"2023-10-08T15:12:19.711655-05:00",
"timezone":"America/Chicago"
},
"end":{
"timestamp":"2023-10-08T15:57:19.711655-05:00",
"timezone":"America/Chicago"
},
"stop_id":"5fca00c3-e96b-414f-85c6-16c0253920aa",
"carrier_name":null,
"carrier_contact":null,
"carrier_tenant_id":"01HC0QGFV2NK7ZY30TVC55EGS9",
"driver_id":null,
"appointment_type":"BY_APPOINTMENT_ONLY",
"delivery_type":null,
"scheduled_resource_type":"SHIPMENT",
"scheduled_resource_id":"2bdf16d9-5429-4ef7-bdbb-5ebd6cea9ba5",
"scheduled_resource_metadata":{
"resource_type":"SHIPMENT",
"shipment_id":"2bdf16d9-5429-4ef7-bdbb-5ebd6cea9ba5",
"planned_date":"2023-10-10"
},
"id":"01HC0QGFV6PM477D80F5YRQYV5",
"facility_id":"01HC0QGFT6TWV4E0QZNSQB2QDY",
"dock_id":null,
"status":"SCHEDULED",
"is_closed":false,
"created_by":"b9d68079-da66-46bc-8da4-e3c751487def",
"deleted_by":null,
"checked_in_at":null,
"checked_in_by_user_id":null,
"checked_out_at":null,
"checked_out_by_user_id":null,
"rejected_at":null,
"rejected_reasons":null,
"scheduled_resource_reference_id":null
}
appointment.rescheduled
Example
{
"name":"Hold the Door",
"reason":"OTHER",
"reference_id":"123456789",
"description":"Some description",
"is_all_day":false,
"matched_load_type_id":"01HC0PNG8TX8YK26A14DXC0VVS",
"references":[
{
"qualifier":"SHIPMENT_REFERENCE_ID",
"value":"RFS2QT"
},
{
"qualifier":"BOL_NUMBER",
"value":"SW2305474"
},
{
"qualifier":"PRO_NUMBER",
"value":"PRO#22232"
},
{
"qualifier":"CUSTOMER_REFERENCE_NUMBER",
"value":"CRN#777"
}
],
"start":{
"timestamp":"2023-10-08T15:15:12.682958-05:00",
"timezone":"America/Chicago"
},
"end":{
"timestamp":"2023-10-08T16:00:12.682958-05:00",
"timezone":"America/Chicago"
},
"stop_id":"5fca00c3-e96b-414f-85c6-16c0253920aa",
"carrier_name":null,
"carrier_contact":null,
"carrier_tenant_id":"01HC0QNRRWZRTH16G7YZE0FX8R",
"driver_id":null,
"appointment_type":"BY_APPOINTMENT_ONLY",
"delivery_type":null,
"scheduled_resource_type":"SHIPMENT",
"scheduled_resource_id":"2bdf16d9-5429-4ef7-bdbb-5ebd6cea9ba5",
"scheduled_resource_metadata":null,
"id":"01HC0QNRRZRXJ77AJEQJWDJG7G",
"facility_id":"01HC0QNRR71DJM1D8KX5FZ4RGN",
"dock_id":"01HC0QNRRT0YTFR8RVVNZRFPB8",
"status":"SCHEDULED",
"is_closed":false,
"created_by":null,
"deleted_by":null,
"checked_in_at":null,
"checked_in_by_user_id":null,
"checked_out_at":null,
"checked_out_by_user_id":null,
"rejected_at":null,
"rejected_reasons":null,
"scheduled_resource_reference_id":null
}
appointment.cancelled
Example
{
"name":"Hold the Door",
"reason":"OTHER",
"reference_id":"123456789",
"description":"Some description",
"is_all_day":false,
"matched_load_type_id":"01HC0PNG8TX8YK26A14DXC0VVS",
"references":[
{
"qualifier":"SHIPMENT_REFERENCE_ID",
"value":"RFS2QT"
},
{
"qualifier":"BOL_NUMBER",
"value":"SW2305474"
},
{
"qualifier":"PRO_NUMBER",
"value":"PRO#22232"
},
{
"qualifier":"CUSTOMER_REFERENCE_NUMBER",
"value":"CRN#777"
}
],
"start":null,
"end":null,
"stop_id":"10a53037-802e-4569-a5f4-5e52b51125bd",
"carrier_name":"Planet Express",
"carrier_contact":"Philip J. Fry",
"carrier_tenant_id":"52f633a0-e5fe-4f93-bff4-019d2e547d61",
"driver_id":"d914073f-dd6c-49ae-910f-eff06bfb882b",
"appointment_type":"BY_APPOINTMENT_ONLY",
"delivery_type":null,
"scheduled_resource_type":"SHIPMENT",
"scheduled_resource_id":"d417832f-3e6a-45f8-b329-2534172face4",
"scheduled_resource_metadata":{
"resource_type":"SHIPMENT",
"shipment_id":"d417832f-3e6a-45f8-b329-2534172face4",
"planned_date":"2023-10-10"
},
"id":"01HC0QK6Y1X9SQH69H1F1XDHZ9",
"facility_id":"01HC0QK6X3PVZ9Y1M3T2F6G93R",
"dock_id":null,
"status":"CANCELLED",
"is_closed":true,
"created_by":null,
"deleted_by":null,
"checked_in_at":{
"timestamp":"2023-10-05T15:13:48.883011-05:00",
"timezone":"America/Chicago"
},
"checked_in_by_user_id":null,
"checked_out_at":{
"timestamp":"2023-10-05T15:43:48.883054-05:00",
"timezone":"America/Chicago"
},
"checked_out_by_user_id":null,
"rejected_at":{
"timestamp":"2023-10-05T15:53:48.882933-05:00",
"timezone":"America/Chicago"
},
"rejected_reasons":"Serious Reasons",
"scheduled_resource_reference_id":null
}