Get Facility Availability

​

Use this API to find open appointment slots for a given Facility.

Body

  • end
    Type: stringFormat: date-time
    required

    As an ISO 8601 date-time string.

  • facility_id
    Type: stringFormat: uuid
    required

    The unique id of the Facility

  • order_info
    Type: array of object
    required

    An object representing the contents of the truck.

    Properties: 1
  • start
    Type: stringFormat: date-time
    required

    As an ISO 8601 date-time string.

  • type
    Type: string
    required

    Either Inbound for deliveries or Outbound for pickups.

  • load_type_names
    Type: array of string

    Names of load types the appointment would carry, matched case-insensitively against the load types configured on the Facility. The returned slots follow those load types' schedules, durations and capacity. A name that matches no load type for the facility and type fails the request.

Responses

  • application/json
Request Example for post/conduit.v1.get_facility_availability
curl https://api.getconduit.ai/conduit.v1.get_facility_availability \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "facility_id": "2aae24c7-438d-473f-aba8-7793b7efdec3",
  "start": "2023-01-01T00:00:00-08:00",
  "end": "2023-01-10T00:00:00-08:00",
  "type": "Inbound",
  "order_info": [
    {
      "reference_id": ""
    }
  ],
  "load_type_names": [
    "Dry Van"
  ]
}'

[
  {
    "status": "Open",
    "scheduled_start_time": "2023-05-10T10:00:00-07:00",
    "scheduled_end_time": "2023-05-10T12:00:00-07:00",
    "type": "Inbound"
  }
]
Previous
Validate Reference Ids
Next
Request FacilityAppointment