Schedule Appointment

Schedule an unscheduled Appointment

SecurityAPIKeyHeader
Request
path Parameters
appointment_id
required
string (Appointment Id)
query Parameters
override_availability_restrictions
boolean (Override Availability Restrictions)
Default: false

Bypass any restrictions on appointment scheduling that would normally apply. This allows you to ignore things such as facility hours of operation, holidays, max appointment capacity, etc. Providing a true value for this parameter will fail if the user does not have override permissions.

Request Body schema: application/json
required
required
object (DateTimeWithTimezone)
required
object (DateTimeWithTimezone)
dock_id
string (Dock Id)

Dock at which we want to schedule the appointment, or null if the appointment should not be scheduled for any specific dock.

name
string (Name)
reason
string (AppointmentReason)

Reason for the Appointment.

Enum: "PRE_LOAD" "MAINTENANCE" "FREIGHT" "STAGING" "OTHER"
reference_id
string (Reference Id)
description
string (Description)
is_all_day
boolean (Is All Day)
Default: false

If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.

matched_load_type_id
string (Matched Load Type Id)

ID of the LoadType whose fields should be used to determine if it matches an Appointment.

Array of objects (References)

List of references for the appointment that can be used to search for the appointment later, or null if appointment references should not be modified by this request.

Responses
200

Successful Response

Response Schema: application/json
name
string (Name)
reason
string (AppointmentReason)

Reason for the Appointment.

Enum: "PRE_LOAD" "MAINTENANCE" "FREIGHT" "STAGING" "OTHER"
reference_id
string (Reference Id)
description
string (Description)
is_all_day
boolean (Is All Day)
Default: false

If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.

matched_load_type_id
string (Matched Load Type Id)

ID of the LoadType whose fields should be used to determine if it matches an Appointment.

Array of objects (References)
Default: []

List of references for the appointment that can be used to search for the appointment later.

object (DateTimeWithTimezone)
object (DateTimeWithTimezone)
stop_id
string (Stop Id) [ 26 .. 36 ] characters
carrier_name
string (Carrier Name)
carrier_contact
string (Carrier Contact)
carrier_tenant_id
string (Carrier Tenant Id) [ 26 .. 36 ] characters
driver_id
string (Driver Id) [ 26 .. 36 ] characters
appointment_type
string (FacilityAppointmentType)
Default: "BY_APPOINTMENT_ONLY"

An enumeration.

Enum: "BY_APPOINTMENT_ONLY" "FIRST_COME_FIRST_SERVE"
delivery_type
string (DeliveryTypeEnum)

Whether the delivery type is loading or unloading Freight.

Enum: "RECEIVING" "SHIPPING"
scheduled_resource_type
string (ScheduledResourceTypeEnum)

Required when the scheduled_resource_id field is provided.

Enum: "FREIGHT_GENERAL" "SHIPMENT" "SERVICE" "LEG"
scheduled_resource_id
string (Scheduled Resource Id) [ 26 .. 36 ] characters
any (Scheduled Resource Metadata)

Additional details about the resource for which this Appointment is scheduling, or null if the Appointment does not relate to any scheduled resource. For example, if this Appointment relates to a Shipment, these details will be described by a ShipmentAppointmentScheduledResource. Or if the Appointment is managing off-platform freight, the details will instead be described using the FreightAppointmentScheduledResource schema.

id
required
string (Id) = 26 characters
facility_id
required
string (Facility Id)

Facility at which the appointment takes place

dock_id
string (Dock Id)

Dock at which the appointment is scheduled, or null if the appointment is not scheduled for any specific dock.

status
required
string (AppointmentStatusEnum)

An enumeration.

Enum: "UNSCHEDULED" "SCHEDULED" "RESCHEDULED" "CANCELLED" "ARRIVED" "ARRIVED_LATE" "DELAYED" "DOCK_IN_USE" "REJECTED" "NO_SHOW" "COMPLETED" "DOCK_IS_READY"
is_closed
boolean (Is Closed)

Check the status of appointment to see why it's closed.

created_by
string (Created By) [ 26 .. 36 ] characters

Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.

deleted_by
string (Deleted By) [ 26 .. 36 ] characters

Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.

object (DateTimeWithTimezone)
checked_in_by_user_id
string (Checked In By User Id) [ 26 .. 36 ] characters
object (DateTimeWithTimezone)
checked_out_by_user_id
string (Checked Out By User Id) [ 26 .. 36 ] characters
object (DateTimeWithTimezone)
rejected_reasons
string (Rejected Reasons)
scheduled_resource_reference_id
string (Scheduled Resource Reference Id) [ 6 .. 8 ] characters
400

Validation Error

post/facilities/appointments/{appointment_id}/schedule
Request samples
application/json
{
  • "start": {
    },
  • "end": {
    },
  • "dock_id": "string",
  • "name": "string",
  • "reason": "PRE_LOAD",
  • "reference_id": "string",
  • "description": "string",
  • "is_all_day": false,
  • "matched_load_type_id": "string",
  • "references": [
    ]
}
Response samples
application/json
{
  • "name": "string",
  • "reason": "PRE_LOAD",
  • "reference_id": "string",
  • "description": "string",
  • "is_all_day": false,
  • "matched_load_type_id": "string",
  • "references": [ ],
  • "start": {
    },
  • "end": {
    },
  • "stop_id": "stringstringstringstringst",
  • "carrier_name": "string",
  • "carrier_contact": "string",
  • "carrier_tenant_id": "stringstringstringstringst",
  • "driver_id": "stringstringstringstringst",
  • "appointment_type": "BY_APPOINTMENT_ONLY",
  • "delivery_type": "RECEIVING",
  • "scheduled_resource_type": "FREIGHT_GENERAL",
  • "scheduled_resource_id": "stringstringstringstringst",
  • "scheduled_resource_metadata": {
    },
  • "id": "stringstringstringstringst",
  • "facility_id": "string",
  • "dock_id": "string",
  • "status": "UNSCHEDULED",
  • "is_closed": true,
  • "created_by": "stringstringstringstringst",
  • "deleted_by": "stringstringstringstringst",
  • "checked_in_at": {
    },
  • "checked_in_by_user_id": "stringstringstringstringst",
  • "checked_out_at": {
    },
  • "checked_out_by_user_id": "stringstringstringstringst",
  • "rejected_at": {
    },
  • "rejected_reasons": "string",
  • "scheduled_resource_reference_id": "string"
}
Copyright © Shipwell 2024. All right reserved.