Stop Appointment Reschedule

4 min

The Stop_appointment_Reschedule callback will allow you to ensure that appointment reschedule events at stops are communicated effectively to subscribed systems. By integrating it into the standard TMS callbacks, customers can receive real-time updates.

{
    "FourKitesLoadId": 14468003,
    "LoadNumber": "TestApp",
    "MessageType": "STOP_APPOINTMENT_RESCHEDULED",
    "NewAppointmentTime": "2024-11-24T19:55:00.000Z",
    "NewEarliestAppointmentTime": "2024-11-24T17:05:00.000Z",
    "NewLatestAppointmentTime": "2024-11-24T19:55:00.000Z",
    "OldAppointmentTime": "2024-11-24T19:55:00.000Z",
    "OldEarliestAppointmentTime": "2024-11-24T16:05:00.000Z",
    "OldLatestAppointmentTime": "2024-11-24T19:55:00.000Z",
    "ProNumber": null,
    "ReferenceNumbers": [],
    "RescheduledAt": "2024-11-25T09:54:05.287Z",
    "Scac": null,
    "Shipper": "shipperApi",
    "StopId": 96246338,
    "StopName": "Newark, NJ",
    "StopSequence": null,
    "StopType": "pickup",
    "Tags": [],
    "Timezone": "America/New_York"
}

Field Description

Field Name	Description	Key Always Present?	Value Always Present?	Conditions for the Key to be present	Data Type	Max Length
FourKitesLoadId	Unique load identifier of the load from the FourKites system that the stop belongs to	Yes	Yes	N/A	Number	20
LoadNumber	Unique shipment identifier from shipper's system	Yes	Yes	N/A	String	65535
ProNumber	Shipment's PRO #	Yes	No	N/A	Number	10
Shipper	Unique shipper ID from FourKites	Yes	Yes	N/A	String	No max, but realistically, not longer than 200 characters
NewAppointmentTime	Appointment time newly modified as part of the reschedule	Yes	No	N/A	String	30
NewEarliestAppointmentTime	New Earliest Appointment Time of the stop. If not a window, both Earliest and Latest Appointment times will be the same.	Yes	No	N/A	String	30
NewLatestAppointmentTime	New Latest Appointment Time of the stop. If not a window, both Earliest and Latest Appointment times will be the same.	Yes	No	N/A	String	30
OldAppointmentTime	Old Appointment time that was pre-existing before reschedule	Yes	No	N/A	String	30
OldEarliestAppointmentTime	Old Earliest Appointment Time of the stop. If not a window, both Earliest and Latest Appointment times will be the same.	Yes	No	N/A	String	30
OldLatestAppointmentTime	Old Latest Appointment Time of the stop. If not a window, both Earliest and Latest Appointment times will be the same.	Yes	No	N/A	String	30
Scac	SCAC of the carrier assigned to the shipment/load	Yes	Yes	- SCAC code of the carrier on the load (or)

If there are managing/operating carrier setup, this would be the SCAC code of the managing carrier on the load | String | | | StopSequence | Sequence number of the particular stop | Yes | Yes | N/A | Number | 10 | | StopId | ID of the stop provided during load creation | Yes | No | N/A | string | 1024 | | StopName | Name of the stop provided during load creation. | Yes | No | N/A | String | No max | | StopType | The stop type for which the ETA corresponds | Yes | Yes | 1. If the transportation mode is ocean and if the stopType is pickup, it will be mapped as Port of Loading 2. If the stopType is transfer for an Ocean load, it will be mapped as TranshipmentPort. 3. If the load is Air, and if the stopType is pickup then the field will be mapped as as origin airport. 4. If the load is Air, and if the stopType is Delivery then the field will be mapped as destination airport. 5. If the load is Air, and if the stopType is transfer then the field will be mapped as hub airport. 6. If the transportation mode is not ocean and air, it will be mapped directly to the value sent by the customer during load creation. | String | 1024 | | TimeZone | | Yes | Yes | N/A | String | 50 | | ReferenceNumbers | Array of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | | No | N/A | Array | no max |