List Facility Availability

Get a list of availabilities at a specified facility.

SecurityAPIKeyHeader
Request
path Parameters
facility_id
required
string (Facility Id)
query Parameters
include
Array of strings (AvailabilityIncludeParams)
Default: []
Items Enum: "load_type_dock_rule_match_results.best_matched_load_type" "load_type_dock_rule_match_results.all_matched_dock_rules"
Request Body schema: application/json
required
delivery_type
string (DeliveryTypeEnum)

An enumeration.

Enum: "RECEIVING" "SHIPPING"
mode
string (DockSchedulingModeEnum)

An enumeration.

Enum: "FTL" "LTL" "VLTL" "DRAYAGE" "PARCEL" "INTERMODAL" "RAIL_CAR" "AIR" "FCL" "LCL"
equipment_type
string (DockSchedulingEquipmentTypeEnum)

An enumeration.

Enum: "DRY_VAN" "REEFER" "FLATBED" "CONTAINER" "AUTOHAULER" "BULK" "TANKER" "CURTAIN_SIDE" "HOPPER" "DROP_DECK" "OTHER" "TILT" "CONTAINER_INSULATED" "CONESTOGA" "FLATBED_CONESTOGA" "STEPDECK_CONESTOGA" "CONTAINER_REFRIGERATED" "B_TRAIN" "DOUBLE_DROP" "DROP_DECK_LANDOLL" "DUMP_TRAILER" "FLATBED_HOTSHOT" "FLATBED_MAXI" "LOWBOY" "LOWBOY_OVERDIMENSION" "REMOVABLE_GOOSENECK" "STRETCH_TRAILER" "TRUCK_AND_TRAILER" "STEP_DECK" "HOPPER_BOTTOM" "PNEUMATIC" "FLATBED_53_FOOT" "FLATBED_AIR_RIDE" "FLATBED_DOUBLE" "FLATBED_OVERDIMENSION" "AUTO_CARRIER" "CONVEYOR" "POWER_ONLY" "STRAIGHT_BOX_TRUCK" "INSULATED_VAN" "REEFER_AIR_RIDE" "REEFER_DOUBLE" "REEFER_INTERMODAL" "TANKER_ALUMINUM" "TANKER_INTERMODAL" "TANKER_STEEL" "MOVING_VAN" "VAN_DOUBLE" "VAN_INSULATED" "VAN_INTERMODAL" "VAN_OPEN_TOP" "VAN_ROLLER_BED" "VAN_TRIPLE" "VAN_VENTED" "VAN_WITH_CURTAINS" "VAN_AIR_RIDE" "VAN_SPRINTER" "CONTAINER_BREAK_BULK" "CONTAINER_FLAT_TRACK_20_FOOT" "CONTAINER_FLAT_TRACK_40_FOOT" "CONTAINER_HEAVY_TESTED_20_FOOT" "CONTAINER_HIGH_CUBE_20_FOOT" "CONTAINER_HIGH_CUBE_40_FOOT" "CONTAINER_OPEN_TOP_20_FOOT" "CONTAINER_OPEN_TOP_40_FOOT" "CONTAINER_REEFER_20_FOOT" "CONTAINER_REEFER_40_FOOT" "CONTAINER_REEFER_TANK_20_FOOT" "CONTAINER_STANDARD_20_FOOT" "CONTAINER_STANDARD_40_FOOT" "CONTAINER_HIGH_CUBE_45_FOOT" "CONTAINER_ISO_TANK_20_FOOT" "CONTAINER_ISO_TANK_24_FOOT" "CONTAINER_ISO_TANK_40_FOOT" "CONTAINER_53_FOOT" "CONTAINER_OVERSIZE" "MULTI_COMPARTMENT" "LIQUID_BULK_TANKER" "DRY_BULK_TANKER" "CARGO_VAN" "MINI_VAN" "SEDAN" "TBOX_RAILCAR" "CRYO_RAILCAR" "DRIVEAWAY" "CUSTOMER_PICKUP" "DROP_TRAILER" "AUTO_RACK_BI_LEVEL" "AUTO_RACK_TRI_LEVEL" "AUTO_MAX" "BOXCAR" "BULKHEAD_FLATCAR" "CENTERBEAM_FLATCAR" "CHAIN_TIE_DOWN_FLATCAR" "COAL_CAR" "COIL_STEEL_RAILCAR" "COVERED_COIL_RAILCAR" "COVERED_HOPPER" "GONDOLA" "OPEN_TOP_HOPPER" "PIPE_FLATCAR" "REFRIGERATED_BOXCAR" "TEMP_CONTROLLED_TRAILER" "TRAILER" "HALF_TON_TRUCK" "ONE_TON_TRUCK" "MINI_FLOAT_TRAILER_AND_TRUCK" "TOWING" "CONESTOGA_48" "CONESTOGA_53" "FLATBED_CONESTOGA_48" "FLATBED_CONESTOGA_53" "STEPDECK_CONESTOGA_48" "STEPDECK_CONESTOGA_53" "CO_FLATBED" "CO_STAKE_BED" "TILTBED_48_WENCH" "WRECKER_TILTBED" "AIRCRAFT" "FOUR_AXLE_HEAVY_HAUL_TRAILER" "UNKNOWN"
product_reference
string (Product Reference)
product_category
Array of strings (Product Category)
packaging_type
string (PackagingTypes)

An enumeration.

Enum: "PLT" "PKG" "FLOOR_LOADED" "BAG" "BALE" "BIN" "BOTTLE" "BOX" "BUCKET" "PAIL" "BUNDLE" "CAN" "CARTON" "CASE" "COIL" "CRATE" "CYLINDER" "DRUM" "JERRICAN" "PACKAGE" "PIECES" "REEL" "ROLL" "SKID" "TUBE" "TOTE_BIN" "TOTE_CAN" "UNIT" "OTHER"
stackable
boolean (Stackable)
is_hazmat
boolean (Is Hazmat)
request_criteria_type
string (Request Criteria Type)
Default: "FREIGHT_GENERAL"
start_datetime
required
string <date-time> (Start Datetime)
end_datetime
required
string <date-time> (End Datetime)
dock_ids
Array of strings (Dock Ids) non-empty

Filter results to only the desired dock ID(s)

rescheduling_for_appointment_id
string (Rescheduling For Appointment Id) non-empty

Indicates that the user wants availability in order to reschedule this Appointment

Responses
200

Successful Response

Response Schema: application/json
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.'

400

Validation Error

post/facilities/{facility_id}/availability
Request samples
application/json
{
  • "delivery_type": "RECEIVING",
  • "mode": "FTL",
  • "equipment_type": "DRY_VAN",
  • "product_reference": "string",
  • "product_category": [
    ],
  • "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": [
    ],
  • "rescheduling_for_appointment_id": "string"
}
Response samples
application/json
{
  • "available_windows": [
    ],
  • "load_type_dock_rule_match_results": {
    },
  • "availability_restrictions": [
    ]
}
Copyright © Shipwell 2024. All right reserved.