---
title: Auto-scheduled
slug: fourkites-api-reference/auto-scheduled
description: Learn about the callback triggered when appointments are auto-scheduled at a facility. This document outlines the request parameter, including appointment times, carrier information, facility name, load number, message type, planned time, shipper details,
createdAt: 2023-10-20T08:58:07.000Z
---

This callback is triggered when the appointments get auto-scheduled at the facility.

## Request Parameter

```json
{
	"AppointmentTimeEnd": "2023-10-13T08:00:00.000Z",
	"AppointmentTimeStart": "2023-10-13T07:00:00.000Z",
	"Carrier": "dytest-carrier",
	"CheckInAt": "0001-01-01T00:00:00.000Z",
	"CheckOutAt": "0001-01-01T00:00:00.000Z",
	"FacilityName": "124 W Polk St",
	"LoadNumber": "today01",
	"MessageType": "APPOINTMENT_AUTOSCHEDULED",
	"PONumber": null,
	"PlannedTime": "2023-10-13T06:00:00.000Z",
	"ReasonCode": null,
	"ReferenceNumber": null,
	"Scac": null,
	"Shipper": "dytest",
	"ShippingType": "Drop-hook",
	"Status": "Success",
	"StopName": null,
	"StopSequence": null,
	"StopType": "Delivery",
	"Timestamp": "2023-10-13T08:15:53-05:00",
	"UserName": "oasindexerworker"
}
```

## Field Definitions

| **Field Name**         | **Description**                                                                                                                   | **Key Always Present?** | **Data Type**             | **Max Length** | **Default Value**            | **Default Value Data Type** |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------------------- | -------------- | ---------------------------- | --------------------------- |
| `AppointmentStatus`    | Status can be Confirmed, Cancelled, Rescheduled                                                                                   | Yes                     | String                    | No max         | AppointmentStatus            | String                      |
| `LoadNumber`           | Unique shipment identifier from shipper's system                                                                                  | Yes                     | String                    | No max         | Null                         | Null                        |
| `PONumber`             | Shipments PO#                                                                                                                     | Yes                     | 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                     | Array of string           | No max         | Null                         | Null                        |
| `StopName`             | Name of the stop provided during load creation.                                                                                   | Yes                     | String                    | No max         | Null                         | Null                        |
| `ShippingType`         | Shipping type - Live                                                                                                              | Yes                     | String                    | No max         | ShippingType                 | String                      |
| `Shipper`              | Unique shipper ID from FourKites                                                                                                  | Yes                     | String                    | No max         | ShipperName                  | String                      |
| `Carrier`              | Unique Carrier ID from FourKites                                                                                                  | Yes                     | String                    | No max         | Null                         | Null                        |
| `Scac`                 | SCAC of the Carrier                                                                                                               | Yes                     | String                    | No max         | Null                         | Null                        |
| `PlannedTime`          | Wanted time provided by the Shipper                                                                                               | Yes                     | String in DateTime format |                | Baseline time representation | Null                        |
| `AppointmentTimeStart` | Start Time from the Appointment Window                                                                                            | Yes                     | String in DateTime format |                | Always present               |                             |
| `AppointmentTimeEnd`   | End Time from the Appointment Window                                                                                              | Yes                     | String in DateTime format |                | Always present               |                             |
| `StopSequence`         | Sequence of the stop on the load that the truck departed from                                                                     | Yes                     | int64                     | No max         | Null                         | Null                        |
| `ReasonCode`           | Configured by facilities within Appointement Manager                                                                              | Yes                     | String                    | No max         | Null                         | Null                        |
| `CheckInAt`            | Check-in date and time in hh\:mm                                                                                                  | Yes                     | String in DateTime format |                | Baseline time representation |                             |
| `CheckOutAt`           | Check-out date and time in hh\:mm                                                                                                 | Yes                     | String in DateTime format |                | Baseline time representation |                             |
| `UserName`             | User who did check-in & check-out                                                                                                 | Yes                     | String                    | No max         | UserName                     | String                      |
| `FacilityName`         | Name of the Facility                                                                                                              | 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                     | String in DateTime format |                |                              |                             |
| `StopType`             | Stop type - pickup, terminal, delivery, portOfLoading, transshipmentPort, portOf Discharge.                                       |                         | String                    | No max         | AppointmentType/SlotType     | String                      |
| `Status`               | Status can be Confirmed, Cancelled, Rescheduled                                                                                   |                         | String                    | No max         | AppointmentStatus            | String                      |