Shipper DocumentationSupport
Guides
Start typing to search…

[OPTIONAL] Appointments to Stops

Creating an ShipmentStopAppointment Object

You can use the ShipmentStopAppointment Object to add greater detail to your various shipment stops. Below are the parameters to add appointment details to a stop:

📘

Support Multi-Day Appointments

Freight Portal supports Multi-Day Appointments by having the start date set on the AppointmentDatePart parameter and the end date set on the AppointmentEndDatePart parameter.

Parameter

Type

Description

AppointmentDatePart

Date

This is the date of the appointment.

If missing and "AppointmentType" is 'OpenWindow', then it will be copied from the "ShipmentStop.StopScheduledDatePart" parameter.

AppointmentEndDatePart

Date

This is the end date of the appointment if it is a multi-day appointment.

AppointmentEndTimePart

TimeSpan

This is the end date of the appointment.

If missing and "AppointmentType" is 'OpenWindow', then it will be copied from the "ShipmentStop.StopScheduledEndTimePart" parameter.

AppointmentStartTimePart

TimeSpan

This is the start date and time of the appointment.

If missing and "AppointmentType" is 'OpenWindow', then it will be copied from the "ShipmentStop.StopScheduledStartTimePart" parameter.

AppointmentType

Enumeration

Enumeration type of the given shipment's appointment type.

Here is an example of the JSON Object:

{
  "Appointment": 
  {
    "AppointmentType": 1,
    "AppointmentDatePart": "2016-12-23",
    "AppointmentEndDatePart": "2016-12-24" ,
    "AppointmentStartTimePart": "11:12:30",
    "AppointmentEndTimePart": "12:22:30"
  }
}

All times should be local to the stop the appointment is being added for.

Complete ShipmentStopAppointment Object

Here you can see an example of a completely valid basic shipment with an appointment time set on both the origin and delivery stop:

{
  "FreightProviderReferenceNumber":"121212112",
  "CarrierScac":"TEST",
  "Stops":
  [
    {
      "StopReference":"Origin",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "Latitude":50.1234,
      "Longitude":-45.1234,
      "Appointment": 
      {
        "AppointmentType": 1,
        "AppointmentDatePart": "2016-08-11",
        "AppointmentEndDatePart": "2018-08-12" ,
        "AppointmentStartTimePart": "00:15:32",
        "AppointmentEndTimePart": "17:31:42"
      }
    },
    {
      "StopReference":"Destination",
      "StopScheduledDatePart":"2018-08-13",
      "StopSequence":2,
      "StopType":3,
      "Latitude":50.4920,
      "Longitude":-44.5543,
      "Appointment": 
      {
        "AppointmentType": 1,
        "AppointmentDatePart": "2018-08-13",
        "AppointmentStartTimePart": "11:12:30",
        "AppointmentEndTimePart": "12:22:30"
      }
    }
  ]
}

Updated about 2 months ago

What’s Next