FacilityAppointment

Facility appointment model.

  • created_at
    Type: string Format: date-time
    read-only
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • facility
    Type: string Format: uuid
    required
  • id
    Type: string Format: uuid
    required
  • is_work_in
    Type: boolean
    required
  • order_info
    Type: array object[]
    required
    • id
      Type: string Format: uuid
      required
    • reference_id
      Type: string
      required
  • recurring_facility_appointment
    Type: object
    required
    • repetition_type
      Type: string enum
      required
      values
      • Daily
      • Weekly
    • id
      Type: string Format: uuid
  • scheduled_end_time
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • scheduled_start_time
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • status
    Type: string enum
    read-only
    required

    Statuses are roughly ordered in the way they will flow through the lifecycle of the appointment.

    Status Description
    Requested Scheduled but pending approval by facility
    Request Declined Facility declined the appointment request
    Scheduled Scheduled for a future date
    Facility Rescheduled Facility rescheduled the appointment
    Rebooked Appointment has been rebooked to a new time
    Late Has not been checked in and past the configured time by the facility
    No Show Has not been checked in past the configured days by the facility
    Checked In Carrier has checked in at the facility
    Loading Loading in progress
    Loaded Loading has been completed
    Unloading Unloading in progress
    Unloaded Unloading has been completed
    Load Rejected Load was rejected at the facility
    Checked Out Carrier has checked out of the facility
    Cancelled Appointment was cancelled
    Auto Cancelled Appointment was automatically cancelled by the system
    Carrier Cancelled Appointment was cancelled by the carrier
    Facility Cancelled Appointment was cancelled by the facility
    Deleted Appointment has been deleted
    values
    • Cancelled
    • Checked Out
    • Checked In
    • Loading
    • Unloading
  • type
    Type: string enum
    required
    values
    • Inbound
    • Outbound
  • updated_at
    Type: string Format: date-time
    read-only
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • all_load_types
    Type: array object[]
    • id
      Type: string Format: uuid
    • name
      Type: string
  • cancelled_at
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • cancelled_note
    Type: string | null
  • cancelled_reason
    Type: string | null enum
    values
    • FACILITY_REJECTED_LOAD
    • FACILITY_DENIED_REQUEST
    • FACILITY_CANCELLED_APPOINTMENT
    • CARRIER_CANCELLED_APPOINTMENT
    • AUTO_CANCEL
    • null
  • carrier
    Type: string | null
  • carrier_driver
    Type: string | null
  • carrier_email
    Type: string | null
  • carrier_emails
    Type: array string[]
  • carrier_notes
    Type: string | null
  • carrier_phone
    Type: string | null
  • checked_in_at
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • checked_out_at
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • confirmation_code
    Type: string | null
  • dock
    Type: string | null
  • estimated_start_datetime
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • forklift
    Type: string | null
  • load_finished_at
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • load_started_at
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • loading_type
    Type: string | null enum
    values
    • Live
    • Drop
  • notes
    Type: string

    Notes created by facility staff and only visible to facility staff

  • public_notes
    Type: string

    Notes created by facility staff and visible to external parties that can view appointment (booker, etc)

  • quantity
    Type: integer | null
    min:  
    1
    max:  
    2147483647

    Integer numbers.

  • seal_number
    Type: string | null
  • shipper_receiver
    Type: string | null
  • trailer_number
    Type: string | null
  • units
    Type: string | null