Cancelled

2 min

Whenever an Appointment is cancelled in the Appointment Manager, an Appointment cancelled callback has to be triggered with the specific information.

Request Parameter

{
	"AppointmentTimeEnd": "2023-10-13T16:00:00.000Z",
	"AppointmentTimeStart": "2023-10-13T15:00:00.000Z",
	"Carrier": null,
	"CheckInAt": "0001-01-01T00:00:00.000Z",
	"CheckOutAt": "0001-01-01T00:00:00.000Z",
	"FacilityName": "124 W Polk St",
	"LoadNumber": "today01",
	"MessageType": "APPOINTMENT_CANCELLED",
	"PONumber": null,
	"PlannedTime": "0001-01-01T00:00:00.000Z",
	"ReasonCode": "Heavy rain",
	"ReferenceNumber": null,
	"Scac": null,
	"Shipper": "dytest",
	"ShippingType": "Drop-hook",
	"StopName": null,
	"StopSequence": null,
	"StopType": "Delivery",
	"Timestamp": "2023-10-13T08:15:53-05:00",
	"UserName": "sowmya-g"
}

Field Description

Field Name	Description	Key Always Present?	Value Always Present?	Data Type	Max Length	Default Value	Default Value Max Length
LoadNumber	Unique shipment identifier from shipper's system	Yes	Yes	String	No max	Null	Null
PONumber	Shipments PO#	Yes	No	Array of string	No max	Null	Null
ReferenceNumber	List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load)	Yes	Yes	Array of string	No max	Null	Null
StopName	Name of the stop provided during load creation.	Yes	Yes	String	No max	Null	Null
ShippingType	Shipping type - Live	Yes	Yes	String	No max	ShippingType	String
Shipper	Unique shipper ID from FourKites	Yes	Yes	String	No max	ShipperName	String
Carrier	Unique Carrier ID from FourKites	Yes	Yes	String	No max	Null	Null
Scac	SCAC of the Carrier	Yes	Yes	String	No max	Null	Null
PlannedTime	Wanted time provided by the Shipper	Yes	Yes	String in DateTime format		Baseline time representation	Null
AppointmentTimeStart	Start Time from the Appointment Window	Yes	Yes	String in DateTime format		Always present
AppointmentTimeEnd	End Time from the Appointment Window	Yes	Yes	String in DateTime format		Always present
StopSequence	Sequence of the stop on the load that the truck departed from	Yes	Yes	int64	No max	Null	Null
ReasonCode	Configured by facilities within Appointement Manager	Yes	Yes	String	No max	Null	Null
CheckInAt	Check-in date and time in hh:mm	Yes	Yes	String in DateTime format		Baseline time representation
CheckOutAt	Check-out date and time in hh:mm	Yes	Yes	String in DateTime format		Baseline time representation
UserName	User who auto scheduled	Yes	Yes	String	No max	UserName	String
FacilityName	Name of the Facility	Yes	Yes	String	No max	FaciltyName	String
Timestamp	Time when the truck arrived at the stop in stop's local time (in ISO 8601 format with local time offset to UTC)	Yes	Yes	String in DateTime format
StopType	Stop type - pickup, terminal, delivery, portOfLoading, transshipmentPort, portOf Discharge.	May or may not be present	Yes	String	No max	AppointmentType/SlotType	String