---
title: Check-out
slug: fourkites-api-reference/check-out
createdAt: 2024-02-02T13:55:55.000Z
---

Whenever any check-out update is made in the Appointment Manager portal, a callback will be triggered.

## Request Parameter

```json
{
  "AppointmentTimeEnd": "2024-01-25T20:30:00.000Z",
  "AppointmentTimeStart": "2024-01-25T19:00:00.000Z",
  "Carrier": null,
  "CheckInAt": "2024-01-25T08:11:16.000Z",
  "CheckOutAt": "2024-01-25T08:11:17.000Z",
  "FacilityName": "8300 Haskell Ave",
  "LoadNumber": "Appt-checkin-checkout",
  "MessageType": "APPOINTMENT_CHECKOUT",
  "PONumber": null,
  "PlannedTime": "0001-01-01T00:00:00.000Z",
  "ReasonCode": null,
  "ReferenceNumber": null,
  "Scac": null,
  "Shipper": "shipper-sera",
  "ShippingType": "Drop-hook",
  "StopName": null,
  "StopSequence": null,
  "StopType": "Delivery",
  "Timestamp": "2024-01-25T02:10:50-06:00",
  "UserName": "automationqat-superadmin"
}
```

## Field Definitions

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