# Drayage API Drayage API documentation Version: 1.0.0 ## Servers Production server ``` https://api.drayeasy.com/api/v2 ``` ## Security ### bearerAuth Type: http Scheme: bearer ## Download OpenAPI description [Drayage API](https://developers.drayeasy.com/_bundle/dray/index.yaml) ## Rate Request ### Get Rate Requests - [GET /rateRequests](https://developers.drayeasy.com/dray/rate-request/paths/~1raterequests/get.md): This endpoint is used to retrieve a list of rate requests. You can filter the results based on the Rate Request ID, Intermodal Region ID, and Destination City ID. ### Create Rate Request - [POST /rateRequests](https://developers.drayeasy.com/dray/rate-request/paths/~1raterequests/post.md): This endpoint is used to create rate requests. It requires specifying the Intermodal Region ID and the ID of the destination city. Optionally, you can provide a specific ZIP code and additional memo notes. ## Intermodal Region ### Get Intermodal Regions - [GET /intermodalRegions](https://developers.drayeasy.com/dray/intermodal-region/getintermodalregions.md): In drayage, an 'intermodal region' is a geographic area that functions as a hub for intermodal transportation, featuring ports and ramps. We divided North America into approximately 100 intermodal regions. ### Get Intermodal Region Suggestions - [GET /intermodalRegions/cities/{cityId}/suggestion](https://developers.drayeasy.com/dray/intermodal-region/getintermodalregionsuggestions.md): In drayage, an 'intermodal region' is a geographic area that functions as a hub for intermodal transportation, featuring ports and ramps. We divided North America into approximately 100 intermodal regions. This API request delivers a list of intermodal regions. ## Order ### Create Order - [POST /createOrder](https://developers.drayeasy.com/dray/order/createorder.md): This endpoint is used to create new orders with detailed information about the shipment, including container details, delivery information, contact emails, and more. ### Get Orders - [GET /orders](https://developers.drayeasy.com/dray/order/searchorders.md): Method: GET URI: /orders ### Upload Files to Order - [POST /orders/{orderId}/files](https://developers.drayeasy.com/dray/order/uploadfilestoorder.md): This endpoint allows you to upload files or provide URLs associated with a specific order. The request should include either an array of files (file_list) or an array of URLs (urls). ### Get Order Files - [GET /orders/{orderId}/files](https://developers.drayeasy.com/dray/order/getorderfiles.md): This endpoint allows you to retrieve files that are associated with a particular order identified by orderId. It's useful for fetching documents, images, or any other files related to the order for viewing or downloading purposes. ### Download Order File - [GET /orders/{orderId}/files/{fileId}](https://developers.drayeasy.com/dray/order/downloadorderfile.md): This endpoint is used to download a specific file associated with an order. By providing the orderId and fileId, you can retrieve and download the file. This functionality is useful for accessing documents, images, or any other files related to a particular order. ### Delete Order File - [DELETE /orders/{orderId}/files/{fileId}](https://developers.drayeasy.com/dray/order/deleteorderfile.md): This endpoint allows you to delete a specific file associated with an order. By providing the orderId and fileId, you can remove the file from the order's files collection. This action is irreversible, so use it with caution as it permanently deletes the specified file. ## Warehouse ### Create Warehouse - [POST /warehouses](https://developers.drayeasy.com/dray/warehouse/createwarehouse.md): This endpoint allows you to create warehouses with various details including name, address, contacts, working hours, and appointment settings. Key features: * Create warehouse with basic information * Set working hours and days * Add multiple contacts with different roles * Configure appointment settings * Specify residential/commercial status ### Get Warehouse Details - [GET /warehouses/{warehouseId}](https://developers.drayeasy.com/dray/warehouse/getwarehouse.md): This endpoint retrieves specific details about a warehouse identified by its unique warehouseId. The response includes comprehensive information about the warehouse, such as its name, code, address, contact details, working hours, time zone, appointment settings, and other relevant information. ### Update Warehouse - [PUT /warehouses/{warehouseId}](https://developers.drayeasy.com/dray/warehouse/updatewarehouse.md): This endpoint allows you to update an existing warehouse in the system. You need to provide the warehouseId of the warehouse you want to update. ### Delete Warehouse - [DELETE /warehouses/{warehouseId}](https://developers.drayeasy.com/dray/warehouse/deletewarehouse.md): This endpoint allows you to delete a specific warehouse identified by its unique warehouseId. Upon successful deletion, the warehouse and all associated data, including contacts, appointments, and other details, will be permanently removed from the system. ## Pickup Number Agent ### Create Pickup Number Agent - [POST /pickupNumberAgents](https://developers.drayeasy.com/dray/pickup-number-agent/createpickupnumberagent.md): The API endpoint is designed to create a pickup number agent. ### Search Pickup Number Agents - [GET /pickupNumberAgents/{pickupNumberAgentId}](https://developers.drayeasy.com/dray/pickup-number-agent/searchpickupnumberagents.md): The API endpoint is used to fetch pickup number agents by their names. ### Update Pickup Number Agent - [PUT /pickupNumberAgents/{pickupNumberAgentId}](https://developers.drayeasy.com/dray/pickup-number-agent/updatepickupnumberagent.md): The API endpoint is designed to update a pickup number agent. ### Delete Pickup Number Agent - [DELETE /pickupNumberAgents/{pickupNumberAgentId}](https://developers.drayeasy.com/dray/pickup-number-agent/deletepickupnumberagent.md): This endpoint is used to delete a specific pickup number agent based on their ID. ## Other ### User Profile - [GET /users/profile](https://developers.drayeasy.com/dray/other/getuserprofile.md): Method: GET ### City Search - [GET /cities](https://developers.drayeasy.com/dray/other/searchcities.md): This API endpoint offers a flexible way to retrieve information about cities by supporting search queries based on city names or UN/LOCODEs. It's designed to help users find detailed city data, including geographic coordinates and zip codes. Note: Either the 'query' or 'unlocode' parameter must be present. However, 'unlocode' should be the only active option when both 'query' and 'unlocode' parameters are present. ### Rate Search - [GET /rates/advanceSearch](https://developers.drayeasy.com/dray/other/getratesearch.md): This API endpoint is designed to facilitate detailed searches for freight rates across various intermodal regions. It allows users to specify criteria such as intermodal region ID, destination city ID, container size, cargo types, and whether the area has limited access.