Last updated 3 minutes ago

Facilities & Dock Scheduling

This page covers tools in the Facilities and Dock Scheduling domains.

Facility Tools

Tool	Description	Use Case	Access
`list_facilities`	List facilities	"Find the address book entry for our Dallas distribution center"	Read
`get_facility`	Get a single facility by ID	Retrieve dock hours, address, and contact info for a specific facility	Read
`create_facility`	Create a new facility	Add a new warehouse or distribution center to the network	Write
`update_facility`	Update facility fields	Update operating hours or contact details for an existing facility	Write
`delete_facility`	Delete a facility	Remove a facility that is no longer in use	Write

Dock Tools

Tool	Description	Use Case	Access
`list_docks`	List docks at a facility	See all available docks before scheduling an appointment	Read
`get_dock`	Get a single dock by ID	Check the equipment type, capacity, and hours for a specific dock	Read
`create_dock`	Create a new dock	Add a new dock door when a facility expands capacity	Write
`update_dock`	Update dock fields	Change a dock's load type restrictions or operating hours	Write
`delete_dock`	Delete a dock	Remove a dock that has been decommissioned	Write

Availability & Appointment Tools

Tool	Description	Use Case	Access
`list_facility_availability`	Get available time slots at a facility	"What appointment slots are open at our Memphis facility tomorrow?"	Read
`list_dock_appointments`	List appointments for a dock	Review the full appointment schedule for a dock on a given day	Read
`get_dock_appointment`	Get a single appointment by ID	Retrieve the details of a specific appointment to confirm timing or carrier	Read
`create_dock_appointment`	Book a dock appointment	Schedule a carrier for a pickup or delivery at a specific dock and time	Write
`update_dock_appointment`	Update an existing appointment	Reschedule an appointment or update the associated shipment	Write
`delete_dock_appointment`	Cancel a dock appointment	Cancel an appointment when a shipment is voided or rescheduled	Write

Load Type Tools

Tool	Description	Use Case	Access
`list_load_types`	List load types for a facility	"Check if our shipment is compatible with the dock requirements at facility X"	Read
`create_load_type`	Create a load type	Define a new load category (e.g. HAZMAT, REEFER) for a facility's docks	Write
`update_load_type`	Update a load type	Modify the requirements or description of an existing load type	Write
`delete_load_type`	Delete a load type	Remove a load type that is no longer applicable	Write

For a general overview of Shipwell's Dock Scheduling APIs, see the Dock Scheduling documentation.