updateTruckloadAdditionalAppointmentWindow

put/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/stops/{stopId}/additional-appointment-windows
SecurityoAuth2
Request
path Parameters
shipmentLegId
required
string <uuid>

shipmentLegId

stopId
required
string <uuid>

stopId

Request Body schema:
required

additionalAppointmentWindow

type
required
string <enum> (TruckloadAdditionalAppointmentWindowType)

The type of appointment window.

Enum: "STRATEGIC" "SLOT_BOOKING_PICKUP" "SLOT_BOOKING_DELIVERY" "SLOT_BOOKING_PICKUP_DELIVERY"
required
object (ZonedDateTimeWindow)

A date and time range, including a time zone, representing a window of availability.

appointmentStatus
string <enum> (AdditionalAppointmentWindowStatus)
Enum: "PENDING" "REJECTED" "BOOKED" "CANCELLED" "COMPLETED" "PENDING_CARRIER" "PENDING_INTERNAL" "NONE_AVAILABLE"
Array of objects (AdditionalAppointmentWindowIdentifier)

A list of identifiers of the additional appointment windows to a shipment.

Responses
200

OK

400

Invalid request

401

Invalid or missing credentials

403

User not authorized to perform this operation

Request samples
{
  • "type": "STRATEGIC",
  • "appointmentWindow": {
    },
  • "appointmentStatus": "PENDING",
  • "identifiers": [
    ]
}
Response samples
{
  • "type": "STRATEGIC",
  • "appointmentWindow": {
    },
  • "appointmentStatus": "PENDING",
  • "identifiers": [
    ]
}

Was this page helpful?