Get a list of availabilities at a specified facility.
Successful Response
required | Array of objects (Available Windows) |
object (Load Type Dock Rule Match Results) Dock rules and LoadTypes that match the requested freight criteria. Will be null if Availability was searched without regard to any particular criteria such as mode, equipment_type, or a specific shipment_id. | |
required | Array of objects (Availability Restrictions) List of restrictions that collectively determined the returned availability windows (and lack thereof). Each record in this list represents an individual rule violation during some timespan when that rule would apply. For example, you might see a record whose fields collectively describe the situation: 'Dock {some_dock_id} will be unavailable from 08:00-12:30 on Jan 5 2022 because it has already reached its max appointment capacity.' It is possible for multiple restrictions to be enforced over the same time period. For example, you could have one restriction on Dec 25, 2022 like 'Facility closes at 5pm' and another restriction that overlaps with the first because 'Facility is closed on Christmas Day.' |
Validation Error
{- "delivery_type": "RECEIVING",
- "mode": "FTL",
- "equipment_type": "DRY_VAN",
- "product_reference": "string",
- "product_category": [
- "string"
], - "packaging_type": "PLT",
- "stackable": true,
- "is_hazmat": true,
- "request_criteria_type": "FREIGHT_GENERAL",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "dock_ids": [
- "string"
], - "rescheduling_for_appointment_id": "string"
}
{- "available_windows": [
- {
- "start": {
- "timestamp": "2019-08-24T14:15:22Z",
- "timezone": "America/Chicago"
}, - "end": {
- "timestamp": "2019-08-24T14:15:22Z",
- "timezone": "America/Chicago"
}, - "dock_id": "string"
}
], - "load_type_dock_rule_match_results": {
- "facility_id": "string",
- "matched_load_type_ids": [
- "string"
], - "matched_docks": [
- {
- "dock_id": "string",
- "dock_rule_ids": [
- "string"
]
}
], - "potential_appointment_types": [
- "BY_APPOINTMENT_ONLY"
], - "all_matched_dock_rules": [
- {
- "delivery_type": "RECEIVING",
- "mode": "FTL",
- "equipment_type": "DRY_VAN",
- "product_reference": "string",
- "product_category": [
- "string"
], - "packaging_type": "PLT",
- "stackable": true,
- "is_hazmat": true,
- "load_type_id": "string",
- "dock_accessorials": [
- "FORK"
], - "temperature": {
- "unit": "C",
- "minimum": "string",
- "maximum": "string"
}, - "appointment_type": "BY_APPOINTMENT_ONLY",
- "first_appointment_start_time": "14:15:22Z",
- "last_appointment_end_time": "14:15:22Z",
- "max_concurrent_appointments": 1,
- "is_public": true,
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "dock_id": "string"
}
], - "best_matched_load_type": {
- "delivery_type": "RECEIVING",
- "mode": "FTL",
- "equipment_type": "DRY_VAN",
- "product_reference": "string",
- "product_category": [
- "string"
], - "packaging_type": "PLT",
- "stackable": true,
- "is_hazmat": true,
- "name": "string",
- "load_unload_duration": "P1DT23H30M4.000000S",
- "appointment_duration": "P1DT23H30M4.000000S",
- "all_day_appointment": false,
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "facility_id": "string"
}
}, - "availability_restrictions": [
- {
- "dock_id": "string",
- "start": "2023-03-06T00:00:00-06:00",
- "end": "2023-03-06T08:00:00-06:00",
- "reason": "Facility opens at 08:00:00"
}
]
}