{ "openapi": "3.0.3", "info": { "contact": { "name": "EchoSync Integrations API", "email": "IntegrationsAPI@echo.com" }, "x-logo": { "url": "https://www.echo.com/themes/custom/echobootstrap/logo.svg", "backgroundColor": "#FFFFFF", "altText": "Echo logo" }, "version": "2.24.1114", "title": "Carrier API", "description": "# Introduction\n\nWelcome to Echo Global Logistics' API reference page! Here you can learn how to access our Available Loads, make offers by placing Bids and send Bookings using our 'Book It Now' feature.\n\n**Supported Authorization strategies:** OAuth 2.0\nplease see [**Authorizer API**](https://app.swaggerhub.com/apis/echogl/Echo_Authorizer/1.0.0) for information on using authorization.\n" }, "servers": [ { "description": "Production environment.", "url": "https://carrierapi.echo.com" } ], "tags": [ { "name": "AvailableLoads", "description": "Operations providing access to available loads." }, { "name": "Bidding", "description": "Operations supporting bidding." }, { "name": "Booking", "description": "Operations supporting booking." } ], "paths": { "/v1/availableloads": { "post": { "operationId": "v1_availableloads", "summary": "Search available loads.", "description": "Search Available Loads is an efficient way to match your capacity to our shipments. Enter any combination of Search Criteria:\n* Equipment\n* Origin/Destination State or States\n* Origin/Destination Zone or Zones\n* Pickup Date(s)\n* Distance\n* Weight\n* Special Services (Hazmat, Team, Temperature)\n", "tags": [ "AvailableLoads" ], "security": [ { "amazon_api_gateway_authorizer_loads_read": [] } ], "parameters": [ { "required": true, "name": "offset", "in": "query", "schema": { "description": "Number of skipped results", "type": "integer", "format": "int32", "minimum": 0, "example": 20 }, "description": "The number of loads to skip before starting to collect the result set", "examples": { "offset": { "summary": "Example of an offset", "value": 20 } } }, { "required": true, "name": "limit", "in": "query", "schema": { "description": "Page size", "type": "integer", "format": "int32", "multipleOf": 10, "minimum": 10, "maximum": 100, "example": 20 }, "description": "The numbers of loads to return, min 10, max 100, increment of 10", "examples": { "limit": { "summary": "Example of a limit", "value": 40 } } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Available loads request", "type": "object", "properties": { "origin": { "description": "Search by load origin", "anyOf": [ { "description": "Search location by city and state or province", "type": "object", "properties": { "city": { "description": "Location city", "type": "string", "minLength": 2, "example": "Chicago" }, "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "required": [ "city", "stateOrProvince" ] }, { "description": "Search location by state", "type": "object", "properties": { "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "additionalProperties": false, "required": [ "stateOrProvince" ] }, { "description": "Search location by states or provinces", "type": "object", "properties": { "statesOrProvinces": { "description": "Location states or provinces", "type": "array", "items": { "type": "string" }, "example": [ "IL", "WI" ] } }, "required": [ "statesOrProvinces" ] }, { "description": "Search location by zone", "type": "object", "properties": { "zone": { "description": "Location zone:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "string", "enum": [ "z0", "z1", "z2", "z3", "z4", "z5", "z6", "z7", "z8", "z9", "ze", "zc", "zw", "zm" ], "example": "z6" } }, "required": [ "zone" ] }, { "description": "Search location by zones", "type": "object", "properties": { "zones": { "description": "Location zones:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "array", "items": { "type": "string" }, "example": [ "z1", "z2" ] } }, "required": [ "zones" ] } ] }, "destination": { "description": "Search by load destination", "anyOf": [ { "description": "Search location by city and state or province", "type": "object", "properties": { "city": { "description": "Location city", "type": "string", "minLength": 2, "example": "Chicago" }, "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "required": [ "city", "stateOrProvince" ] }, { "description": "Search location by state", "type": "object", "properties": { "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "additionalProperties": false, "required": [ "stateOrProvince" ] }, { "description": "Search location by states or provinces", "type": "object", "properties": { "statesOrProvinces": { "description": "Location states or provinces", "type": "array", "items": { "type": "string" }, "example": [ "IL", "WI" ] } }, "required": [ "statesOrProvinces" ] }, { "description": "Search location by zone", "type": "object", "properties": { "zone": { "description": "Location zone:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "string", "enum": [ "z0", "z1", "z2", "z3", "z4", "z5", "z6", "z7", "z8", "z9", "ze", "zc", "zw", "zm" ], "example": "z6" } }, "required": [ "zone" ] }, { "description": "Search location by zones", "type": "object", "properties": { "zones": { "description": "Location zones:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "array", "items": { "type": "string" }, "example": [ "z1", "z2" ] } }, "required": [ "zones" ] } ] }, "pickupDate": { "description": "Search by pickup dates", "type": "array", "uniqueItems": true, "items": { "description": "Search by load pickup dates (YYYY-MM-DD)", "type": "string", "pattern": "^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])", "example": "2021-11-03" } }, "equipment": { "description": "Search by equipment type", "type": "string", "enum": [ "flatbed", "reefer", "van", "van_dry_53", "reefer_53", "flatbed_53", "van_dry_48", "reefer_48", "flatbed_48" ], "example": "van_dry_53" }, "equipmentList": { "description": "Search by many equipment types", "type": "array", "items": { "type": "string", "enum": [ "flatbed", "reefer", "van", "van_dry_53", "reefer_53", "flatbed_53", "van_dry_48", "reefer_48", "flatbed_48" ] }, "example": [ "van_dry_53", "flatbed_53\"" ] }, "mode": { "description": "Search by mode", "type": "string", "enum": [ "tl" ], "default": "tl", "example": "tl" }, "distance": { "description": "Search by range of loaded distance", "type": "object", "properties": { "min": { "description": "Minimum loaded distance", "type": "integer", "format": "int32", "default": 0, "example": 100 }, "max": { "description": "Maximum loaded distance", "type": "integer", "format": "int32", "example": 500 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "max" ] }, "weight": { "description": "Search by range of loaded weight", "type": "object", "properties": { "min": { "description": "Minimum loaded weight", "type": "integer", "format": "int32", "default": 0, "example": 1000 }, "max": { "description": "Maximum loaded weight", "type": "integer", "format": "int32", "example": 5000 }, "units": { "description": "Weight units:\n * `lb` - Pound\n * `kg` - Kilogram\n", "type": "string", "enum": [ "lb", "kg" ], "default": "lb", "example": "lb" } }, "required": [ "max" ] }, "specialServices": { "description": "Search by special services. Set `false` to exclude", "type": "object", "properties": { "hazmat": { "default": true, "description": "Hazardous Materials", "type": "boolean", "example": true }, "temp": { "default": true, "description": "Temperature Requirements", "type": "boolean", "example": true }, "team": { "default": true, "description": "Team Services", "type": "boolean", "example": true } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Available loads response", "type": "object", "properties": { "resultSet": { "description": "Pagination details", "properties": { "count": { "description": "Number of results in response", "type": "integer", "format": "int32", "minimum": 0, "example": 17 }, "offset": { "description": "Number of skipped results", "type": "integer", "format": "int32", "minimum": 0, "example": 20 }, "limit": { "description": "Page size", "type": "integer", "format": "int32", "multipleOf": 10, "minimum": 10, "maximum": 100, "example": 20 }, "total": { "description": "Number of total results", "type": "integer", "format": "int32", "minimum": 0, "example": 37 } } }, "loads": { "description": "Available loads", "type": "array", "items": { "description": "Load details", "type": "object", "properties": { "loadId": { "description": "Echo load id", "type": "string", "example": "6239230" }, "equipment": { "description": "Expected equipment types", "type": "array", "items": { "description": "Equipment type:\n * `van_dry_53` - Dry Van 53'\n * `reefer_53` - Reefer 53'\n * `flatbed_53` - Flatbed 53'\n * `van_dry_48` - Dry Van 48'\n * `reefer_48` - Reefer 48'\n * `flatbed_48` - Flatbed 48'\n * `box_50` - Box 50'\n * `box_60` - Box 60'\n * `container_chassis_53` - Container w/ Chassis 53'\n * `flat_rack_container_20` - Flat Rack Container 20'\n * `flat_rack_container_40` - Flat Rack Container 40'\n * `high_cube_container` - High Cube Container 40'\n * `insulated_container_20` - Insulated Container 20'\n * `insulated_container_40` - Insulated Container 40'\n * `insulated_container_45` - Insulated Container 45'\n * `insulated_container_48` - Insulated Container 48'\n * `insulated_container_53` - Insulated Container 53'\n * `lcl` - LCL\n * `open_top_container_20` - Open Top Container 20'\n * `open_top_container_40` - Open Top Container 40'\n * `refrigerated_container_20` - Refrigerated Container 20'\n * `refrigerated_container_40` - Refrigerated Container 40'\n * `refrigerated_container_45` - Refrigerated Container 45'\n * `refrigerated_container_48` - Refrigerated Container 48'\n * `refrigerated_container_53` - Refrigerated Container 53'\n * `container_20` - Container 20'\n * `container_40` - Container 40'\n * `container_45` - Container 45'\n * `container_48` - Container 48'\n * `container_53` - Container 53'\n * `tank_container_20` - Tank Container 20'\n * `b_train` - B-Train\n * `conestoga_48` - Conestoga 48'\n * `conestoga_53` - Conestoga 53'\n * `double_drop_deck` - Double Drop Deck\n * `extendable_flatbed` - Extendable Flatbed\n * `extendable_rgn` - Extendable RGN\n * `extendable_step_deck` - Extendable Step Deck\n * `flatbed_hotshot` - Flatbed Hotshot\n * `flatbed_side` - Flatbed w/ Side\n * `landoll_flatbed` - Landoll Flatbed\n * `lowboy` - Lowboy\n * `multi_axle_heavy_haulers` - Multi-Axle Heavy Haulers\n * `maxi` - Maxi\n * `removable_goose_neck` - Removable Goose Neck\n * `step_deck_conestoga_48` - Step Deck Conestoga 48'\n * `step_deck_conestoga_53` - Step Deck Conestoga 53'\n * `auto_carrier` - Auto Carrier\n * `air` - Air\n * `animal_carrier` - Animal Carrier\n * `boat_hauling_trailer` - Boat Hauling Trailer\n * `chassis_only` - Chassis Only\n * `cargo_van` - Cargo Van\n * `dump_truck` - Dump Truck\n * `hopper_bottom` - Hopper Bottom\n * `power_only` - Power Only\n * `chassis_only_super` - Chassis Only - Super\n * `sprinter_van` - Sprinter Van\n * `straight_truck` - Straight Truck\n * `chassis_only_tri_axle` - Chassis Only - Tri-Axle\n * `step_deck_48` - Step Deck 48'\n * `step_deck_53` - Step Deck 53'\n * `aluminum_tanker` - Aluminum Tanker\n * `pneumatic_tanker` - Pneumatic Tanker\n * `tanker` - Tanker\n * `trailer_48` - Trailer 48'\n * `trailer_53` - Trailer 53'\n * `steel_tanker` - Steel Tanker\n * `curtain_van_48` - Curtain Van 48'\n * `curtain_van_53` - Curtain Van 53'\n * `double_pup` - Double Pup\n * `straight_hotshot_van_20` - Straight/Hotshot Van 20'\n * `straight_hotshot_van_24` - Straight/Hotshot Van 24'\n * `straight_hotshot_van_28` - Straight/Hotshot Van 28'\n * `straight_hotshot_van_40` - Straight/Hotshot Van 40'\n * `insulated_van_48` - Insulated Van 48'\n * `insulated_van_53` - Insulated Van 53'\n * `logistics_van_48` - Logistics Van 48'\n * `logistics_van_53` - Logistics Van 53'\n * `moving_van` - Moving Van\n * `open_top_van_48` - Open Top Van 48'\n * `open_top_van_53` - Open Top Van 53'\n * `plated_van_48` - Plated Van 48'\n * `plated_van_53` - Plated Van 53'\n * `triple_pup` - Triple Pup\n * `van_liftgate_48` - Van w/ Liftgate 48'\n * `van_liftgate_53` - Van w/ Liftgate 53'\n * `vented_van_48` - Vented Van 48'\n * `vented_van_53` - Vented Van 53'\n * `walking_floor_van` - Walking Floor Van\n", "type": "string", "enum": [ "van_dry_53", "reefer_53", "flatbed_53", "van_dry_48", "reefer_48", "flatbed_48", "box_50", "box_60", "container_chassis_53", "flat_rack_container_20", "flat_rack_container_40", "high_cube_container", "insulated_container_20", "insulated_container_40", "insulated_container_45", "insulated_container_48", "insulated_container_53", "lcl", "open_top_container_20", "open_top_container_40", "refrigerated_container_20", "refrigerated_container_40", "refrigerated_container_45", "refrigerated_container_48", "refrigerated_container_53", "container_20", "container_40", "container_45", "container_48", "container_53", "tank_container_20", "b_train", "conestoga_48", "conestoga_53", "double_drop_deck", "extendable_flatbed", "extendable_rgn", "extendable_step_deck", "flatbed_hotshot", "flatbed_side", "landoll_flatbed", "lowboy", "multi_axle_heavy_haulers", "maxi", "removable_goose_neck", "step_deck_conestoga_48", "step_deck_conestoga_53", "auto_carrier", "air", "animal_carrier", "boat_hauling_trailer", "chassis_only", "cargo_van", "dump_truck", "hopper_bottom", "power_only", "chassis_only_super", "sprinter_van", "straight_truck", "chassis_only_tri_axle", "step_deck_48", "step_deck_53", "aluminum_tanker", "pneumatic_tanker", "tanker", "trailer_48", "trailer_53", "steel_tanker", "curtain_van_48", "curtain_van_53", "double_pup", "straight_hotshot_van_20", "straight_hotshot_van_24", "straight_hotshot_van_28", "straight_hotshot_van_40", "insulated_van_48", "insulated_van_53", "logistics_van_48", "logistics_van_53", "moving_van", "open_top_van_48", "open_top_van_53", "plated_van_48", "plated_van_53", "triple_pup", "van_liftgate_48", "van_liftgate_53", "vented_van_48", "vented_van_53", "walking_floor_van" ], "example": "van_dry_53" } }, "mode": { "description": "Mode:\n * `tl` - Full truckload\n", "type": "string", "enum": [ "tl" ], "default": "tl", "example": "tl" }, "stops": { "description": "Load stops", "type": "array", "minItems": 2, "items": { "description": "Stop details", "type": "object", "properties": { "stopNumber": { "description": "Stop number in the sequence", "type": "integer", "format": "int32", "example": 1 }, "stopType": { "description": "Stop type", "type": "string", "enum": [ "pick", "drop" ], "example": "pick" }, "location": { "description": "Stop location", "type": "object", "properties": { "city": { "description": "Location city", "type": "string", "minLength": 2, "example": "Chicago" }, "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "postalCode": { "description": "Location zip or postal code", "type": "string", "minLength": 5, "example": 60606 }, "country": { "description": "Location country:\n * `USA` - United States of America\n * `CAN` - Canada\n * `MEX` - United Mexican States\n", "type": "string", "enum": [ "USA", "CAN", "MEX" ], "example": "USA" }, "zone": { "description": "Location zone:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "string", "enum": [ "z0", "z1", "z2", "z3", "z4", "z5", "z6", "z7", "z8", "z9", "ze", "zc", "zw", "zm" ], "example": "z6" }, "coordinate": { "description": "Location coordinates", "type": "object", "properties": { "lat": { "description": "Latitude", "type": "number", "format": "float", "example": 41.885681445390645 }, "lon": { "description": "Longitude", "type": "number", "format": "float", "example": -87.6366874973939 } }, "required": [ "lat", "lon" ] } }, "required": [ "city", "stateOrProvince", "postalCode", "country", "zone", "coordinate" ] }, "serviceWindow": { "description": "Service window. Date-times are local to the stop location", "type": "object", "properties": { "start": { "description": "Start date-time of the service window", "type": "string", "format": "date-time", "example": "2021-01-21T07:32:28" }, "end": { "description": "End date-time of the service window", "type": "string", "format": "date-time", "example": "2021-01-21T07:32:28" }, "timezone": { "description": "Timezone abbreviation", "type": "string", "nullable": true, "example": "CT" } }, "required": [ "start", "end", "timezone" ] } }, "required": [ "stopNumber", "stopType", "location", "serviceWindow" ] } }, "distance": { "description": "Total loaded distance", "type": "object", "properties": { "value": { "description": "Loaded distance value", "type": "integer", "format": "int32", "example": 400 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value", "units" ] }, "weight": { "description": "Total loaded weight", "type": "object", "properties": { "value": { "description": "Total loaded weight", "type": "integer", "format": "int32", "example": 4000 }, "units": { "description": "Weight units:\n * `lb` - Pound\n * `kg` - Kilogram\n", "type": "string", "enum": [ "lb", "kg" ], "default": "lb", "example": "lb" } }, "required": [ "value", "units" ] }, "specialServices": { "description": "Load special services", "type": "object", "properties": { "hazmat": { "description": "Hazardous Materials", "type": "boolean", "default": false, "example": true }, "dropReceiver": { "description": "Drop Trailer Receiver", "type": "boolean", "default": false, "example": true }, "dropShipper": { "description": "Drop Trailer Shipper", "type": "boolean", "default": false, "example": true }, "temp": { "description": "Temperature Requirements", "type": "boolean", "default": false, "example": true }, "straps": { "description": "Requires Straps", "type": "boolean", "default": false, "example": true }, "loadBar": { "description": "Requires Load Bar", "type": "boolean", "default": false, "example": true }, "freeze": { "description": "Protect From Freeze", "type": "boolean", "default": false, "example": true }, "tanker": { "description": "Tanker Endorsement", "type": "boolean", "default": false, "example": true }, "tarps": { "description": "Requires tarps", "type": "boolean", "default": false, "example": true }, "od": { "description": "Over Dimensional", "type": "boolean", "default": false, "example": true }, "assist": { "description": "Driver Assist", "type": "boolean", "default": false, "example": true }, "twic": { "description": "TWIC Card", "type": "boolean", "default": false, "example": true }, "team": { "description": "Team Services", "type": "boolean", "default": false, "example": true } } }, "rate": { "description": "Load rate", "type": "object", "nullable": true, "properties": { "value": { "description": "Rate value", "type": "integer", "format": "int32", "minimum": 0, "example": 1000 }, "currency": { "description": "Rate currency:\n * `USD` - United States Dollar\n", "type": "string", "enum": [ "USD" ], "default": "USD", "example": "USD" } }, "required": [ "value", "currency" ] }, "commodity": { "description": "Load commodities", "type": "array", "items": { "description": "Commodity", "type": "string", "example": "boxes" } } }, "required": [ "loadId", "equipment", "mode", "stops", "distance", "weight", "specialServices", "rate", "commodity" ] } } }, "required": [ "resultSet", "loads" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Request", "detail": "The request contained errors and could not be processed.", "status": 400, "errors": [] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Unauthorized", "detail": "The request is unauthorized.", "status": 401 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "description": "Forbidden response", "type": "object", "properties": { "message": { "description": "Error message.", "type": "string", "example": "Forbidden" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Found", "detail": "The requested route has not been found: METHOD - /some/path", "status": 404 } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Method Not Allowed", "detail": "The HTTP method is not allowed on the requested route: METHOD - /some/path", "status": 405 } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Internal Server Error", "detail": "An unknown error has occurred.", "status": 500 } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Implemented", "detail": "The requested route has not been implemented: METHOD - /some/path", "status": 501 } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Gateway", "detail": "The upstream server sent an invalid response.", "status": 502, "errors": [] } } } } } } }, "/v2/availableloads": { "post": { "operationId": "v2_availableloads", "summary": "Search available loads.", "description": "Search Available Loads V2 is an efficient way to match your capacity to our shipments. Enter any combination of Search Criteria, the same as with V1:\n\n* Equipment\n* Origin/Destination State or States\n* Origin/Destination Zone or Zone\n* Pickup Date(s)\n* Distance\n* Weight\n* Special Services (Hazmat, Team, Temperature)\n\nThe only difference is in the Return Body. With V2 you will receive a URL to our EchoDrive web portal where you can directly Bid on or Book the loads.\n", "tags": [ "AvailableLoads" ], "security": [ { "amazon_api_gateway_authorizer_loads_read": [] } ], "parameters": [ { "required": true, "name": "offset", "in": "query", "schema": { "description": "Number of skipped results", "type": "integer", "format": "int32", "minimum": 0, "example": 20 }, "description": "The number of loads to skip before starting to collect the result set", "examples": { "offset": { "summary": "Example of an offset", "value": 20 } } }, { "required": true, "name": "limit", "in": "query", "schema": { "description": "Page size", "type": "integer", "format": "int32", "multipleOf": 10, "minimum": 10, "maximum": 100, "example": 20 }, "description": "The numbers of loads to return, min 10, max 100, increment of 10", "examples": { "limit": { "summary": "Example of a limit", "value": 40 } } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Available loads request", "type": "object", "properties": { "origin": { "description": "Search by load origin", "anyOf": [ { "description": "Search location by city and state or province", "type": "object", "properties": { "city": { "description": "Location city", "type": "string", "minLength": 2, "example": "Chicago" }, "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "required": [ "city", "stateOrProvince" ] }, { "description": "Search location by state", "type": "object", "properties": { "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "additionalProperties": false, "required": [ "stateOrProvince" ] }, { "description": "Search location by states or provinces", "type": "object", "properties": { "statesOrProvinces": { "description": "Location states or provinces", "type": "array", "items": { "type": "string" }, "example": [ "IL", "WI" ] } }, "required": [ "statesOrProvinces" ] }, { "description": "Search location by zone", "type": "object", "properties": { "zone": { "description": "Location zone:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "string", "enum": [ "z0", "z1", "z2", "z3", "z4", "z5", "z6", "z7", "z8", "z9", "ze", "zc", "zw", "zm" ], "example": "z6" } }, "required": [ "zone" ] }, { "description": "Search location by zones", "type": "object", "properties": { "zones": { "description": "Location zones:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "array", "items": { "type": "string" }, "example": [ "z1", "z2" ] } }, "required": [ "zones" ] } ] }, "destination": { "description": "Search by load destination", "anyOf": [ { "description": "Search location by city and state or province", "type": "object", "properties": { "city": { "description": "Location city", "type": "string", "minLength": 2, "example": "Chicago" }, "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "required": [ "city", "stateOrProvince" ] }, { "description": "Search location by state", "type": "object", "properties": { "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "deadHead": { "description": "Deadhead distance from location", "type": "object", "properties": { "value": { "description": "Deadhead value", "type": "integer", "format": "int32", "minimum": 0, "maximum": 300, "default": 0, "example": 100 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value" ] } }, "additionalProperties": false, "required": [ "stateOrProvince" ] }, { "description": "Search location by states or provinces", "type": "object", "properties": { "statesOrProvinces": { "description": "Location states or provinces", "type": "array", "items": { "type": "string" }, "example": [ "IL", "WI" ] } }, "required": [ "statesOrProvinces" ] }, { "description": "Search location by zone", "type": "object", "properties": { "zone": { "description": "Location zone:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "string", "enum": [ "z0", "z1", "z2", "z3", "z4", "z5", "z6", "z7", "z8", "z9", "ze", "zc", "zw", "zm" ], "example": "z6" } }, "required": [ "zone" ] }, { "description": "Search location by zones", "type": "object", "properties": { "zones": { "description": "Location zones:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "array", "items": { "type": "string" }, "example": [ "z1", "z2" ] } }, "required": [ "zones" ] } ] }, "pickupDate": { "description": "Search by pickup dates", "type": "array", "uniqueItems": true, "items": { "description": "Search by load pickup dates (YYYY-MM-DD)", "type": "string", "pattern": "^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])", "example": "2021-11-03" } }, "equipment": { "description": "Search by equipment type", "type": "string", "enum": [ "flatbed", "reefer", "van", "van_dry_53", "reefer_53", "flatbed_53", "van_dry_48", "reefer_48", "flatbed_48" ], "example": "van_dry_53" }, "equipmentList": { "description": "Search by many equipment types", "type": "array", "items": { "type": "string", "enum": [ "flatbed", "reefer", "van", "van_dry_53", "reefer_53", "flatbed_53", "van_dry_48", "reefer_48", "flatbed_48" ] }, "example": [ "van_dry_53", "flatbed_53\"" ] }, "mode": { "description": "Search by mode", "type": "string", "enum": [ "tl" ], "default": "tl", "example": "tl" }, "distance": { "description": "Search by range of loaded distance", "type": "object", "properties": { "min": { "description": "Minimum loaded distance", "type": "integer", "format": "int32", "default": 0, "example": 100 }, "max": { "description": "Maximum loaded distance", "type": "integer", "format": "int32", "example": 500 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "max" ] }, "weight": { "description": "Search by range of loaded weight", "type": "object", "properties": { "min": { "description": "Minimum loaded weight", "type": "integer", "format": "int32", "default": 0, "example": 1000 }, "max": { "description": "Maximum loaded weight", "type": "integer", "format": "int32", "example": 5000 }, "units": { "description": "Weight units:\n * `lb` - Pound\n * `kg` - Kilogram\n", "type": "string", "enum": [ "lb", "kg" ], "default": "lb", "example": "lb" } }, "required": [ "max" ] }, "specialServices": { "description": "Search by special services. Set `false` to exclude", "type": "object", "properties": { "hazmat": { "default": true, "description": "Hazardous Materials", "type": "boolean", "nullable": true, "example": true }, "temp": { "default": true, "description": "Temperature Requirements", "type": "boolean", "example": true }, "team": { "default": true, "description": "Team Services", "type": "boolean", "example": true } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Available loads response", "type": "object", "properties": { "resultSet": { "description": "Pagination details", "properties": { "count": { "description": "Number of results in response", "type": "integer", "format": "int32", "minimum": 0, "example": 17 }, "offset": { "description": "Number of skipped results", "type": "integer", "format": "int32", "minimum": 0, "example": 20 }, "limit": { "description": "Page size", "type": "integer", "format": "int32", "multipleOf": 10, "minimum": 10, "maximum": 100, "example": 20 }, "total": { "description": "Number of total results", "type": "integer", "format": "int32", "minimum": 0, "example": 37 } } }, "loads": { "description": "Available loads", "type": "array", "items": { "description": "Load details", "type": "object", "properties": { "loadId": { "description": "Echo load id", "type": "string", "example": "6239230" }, "equipment": { "description": "Expected equipment types", "type": "array", "items": { "description": "Equipment type:\n * `van_dry_53` - Dry Van 53'\n * `reefer_53` - Reefer 53'\n * `flatbed_53` - Flatbed 53'\n * `van_dry_48` - Dry Van 48'\n * `reefer_48` - Reefer 48'\n * `flatbed_48` - Flatbed 48'\n * `box_50` - Box 50'\n * `box_60` - Box 60'\n * `container_chassis_53` - Container w/ Chassis 53'\n * `flat_rack_container_20` - Flat Rack Container 20'\n * `flat_rack_container_40` - Flat Rack Container 40'\n * `high_cube_container` - High Cube Container 40'\n * `insulated_container_20` - Insulated Container 20'\n * `insulated_container_40` - Insulated Container 40'\n * `insulated_container_45` - Insulated Container 45'\n * `insulated_container_48` - Insulated Container 48'\n * `insulated_container_53` - Insulated Container 53'\n * `lcl` - LCL\n * `open_top_container_20` - Open Top Container 20'\n * `open_top_container_40` - Open Top Container 40'\n * `refrigerated_container_20` - Refrigerated Container 20'\n * `refrigerated_container_40` - Refrigerated Container 40'\n * `refrigerated_container_45` - Refrigerated Container 45'\n * `refrigerated_container_48` - Refrigerated Container 48'\n * `refrigerated_container_53` - Refrigerated Container 53'\n * `container_20` - Container 20'\n * `container_40` - Container 40'\n * `container_45` - Container 45'\n * `container_48` - Container 48'\n * `container_53` - Container 53'\n * `tank_container_20` - Tank Container 20'\n * `b_train` - B-Train\n * `conestoga_48` - Conestoga 48'\n * `conestoga_53` - Conestoga 53'\n * `double_drop_deck` - Double Drop Deck\n * `extendable_flatbed` - Extendable Flatbed\n * `extendable_rgn` - Extendable RGN\n * `extendable_step_deck` - Extendable Step Deck\n * `flatbed_hotshot` - Flatbed Hotshot\n * `flatbed_side` - Flatbed w/ Side\n * `landoll_flatbed` - Landoll Flatbed\n * `lowboy` - Lowboy\n * `multi_axle_heavy_haulers` - Multi-Axle Heavy Haulers\n * `maxi` - Maxi\n * `removable_goose_neck` - Removable Goose Neck\n * `step_deck_conestoga_48` - Step Deck Conestoga 48'\n * `step_deck_conestoga_53` - Step Deck Conestoga 53'\n * `auto_carrier` - Auto Carrier\n * `air` - Air\n * `animal_carrier` - Animal Carrier\n * `boat_hauling_trailer` - Boat Hauling Trailer\n * `chassis_only` - Chassis Only\n * `cargo_van` - Cargo Van\n * `dump_truck` - Dump Truck\n * `hopper_bottom` - Hopper Bottom\n * `power_only` - Power Only\n * `chassis_only_super` - Chassis Only - Super\n * `sprinter_van` - Sprinter Van\n * `straight_truck` - Straight Truck\n * `chassis_only_tri_axle` - Chassis Only - Tri-Axle\n * `step_deck_48` - Step Deck 48'\n * `step_deck_53` - Step Deck 53'\n * `aluminum_tanker` - Aluminum Tanker\n * `pneumatic_tanker` - Pneumatic Tanker\n * `tanker` - Tanker\n * `trailer_48` - Trailer 48'\n * `trailer_53` - Trailer 53'\n * `steel_tanker` - Steel Tanker\n * `curtain_van_48` - Curtain Van 48'\n * `curtain_van_53` - Curtain Van 53'\n * `double_pup` - Double Pup\n * `straight_hotshot_van_20` - Straight/Hotshot Van 20'\n * `straight_hotshot_van_24` - Straight/Hotshot Van 24'\n * `straight_hotshot_van_28` - Straight/Hotshot Van 28'\n * `straight_hotshot_van_40` - Straight/Hotshot Van 40'\n * `insulated_van_48` - Insulated Van 48'\n * `insulated_van_53` - Insulated Van 53'\n * `logistics_van_48` - Logistics Van 48'\n * `logistics_van_53` - Logistics Van 53'\n * `moving_van` - Moving Van\n * `open_top_van_48` - Open Top Van 48'\n * `open_top_van_53` - Open Top Van 53'\n * `plated_van_48` - Plated Van 48'\n * `plated_van_53` - Plated Van 53'\n * `triple_pup` - Triple Pup\n * `van_liftgate_48` - Van w/ Liftgate 48'\n * `van_liftgate_53` - Van w/ Liftgate 53'\n * `vented_van_48` - Vented Van 48'\n * `vented_van_53` - Vented Van 53'\n * `walking_floor_van` - Walking Floor Van\n", "type": "string", "enum": [ "van_dry_53", "reefer_53", "flatbed_53", "van_dry_48", "reefer_48", "flatbed_48", "box_50", "box_60", "container_chassis_53", "flat_rack_container_20", "flat_rack_container_40", "high_cube_container", "insulated_container_20", "insulated_container_40", "insulated_container_45", "insulated_container_48", "insulated_container_53", "lcl", "open_top_container_20", "open_top_container_40", "refrigerated_container_20", "refrigerated_container_40", "refrigerated_container_45", "refrigerated_container_48", "refrigerated_container_53", "container_20", "container_40", "container_45", "container_48", "container_53", "tank_container_20", "b_train", "conestoga_48", "conestoga_53", "double_drop_deck", "extendable_flatbed", "extendable_rgn", "extendable_step_deck", "flatbed_hotshot", "flatbed_side", "landoll_flatbed", "lowboy", "multi_axle_heavy_haulers", "maxi", "removable_goose_neck", "step_deck_conestoga_48", "step_deck_conestoga_53", "auto_carrier", "air", "animal_carrier", "boat_hauling_trailer", "chassis_only", "cargo_van", "dump_truck", "hopper_bottom", "power_only", "chassis_only_super", "sprinter_van", "straight_truck", "chassis_only_tri_axle", "step_deck_48", "step_deck_53", "aluminum_tanker", "pneumatic_tanker", "tanker", "trailer_48", "trailer_53", "steel_tanker", "curtain_van_48", "curtain_van_53", "double_pup", "straight_hotshot_van_20", "straight_hotshot_van_24", "straight_hotshot_van_28", "straight_hotshot_van_40", "insulated_van_48", "insulated_van_53", "logistics_van_48", "logistics_van_53", "moving_van", "open_top_van_48", "open_top_van_53", "plated_van_48", "plated_van_53", "triple_pup", "van_liftgate_48", "van_liftgate_53", "vented_van_48", "vented_van_53", "walking_floor_van" ], "example": "van_dry_53" } }, "mode": { "description": "Mode:\n * `tl` - Full truckload\n", "type": "string", "enum": [ "tl" ], "default": "tl", "example": "tl" }, "stops": { "description": "Load stops", "type": "array", "minItems": 2, "items": { "description": "Stop details", "type": "object", "properties": { "stopNumber": { "description": "Stop number in the sequence", "type": "integer", "format": "int32", "example": 1 }, "stopType": { "description": "Stop type", "type": "string", "enum": [ "pick", "drop" ], "example": "pick" }, "location": { "description": "Stop location", "type": "object", "properties": { "city": { "description": "Location city", "type": "string", "minLength": 2, "example": "Chicago" }, "stateOrProvince": { "description": "Location state or province", "type": "string", "minLength": 2, "example": "IL" }, "postalCode": { "description": "Location zip or postal code", "type": "string", "minLength": 5, "example": 60606 }, "country": { "description": "Location country:\n * `USA` - United States of America\n * `CAN` - Canada\n * `MEX` - United Mexican States\n", "type": "string", "enum": [ "USA", "CAN", "MEX" ], "example": "USA" }, "zone": { "description": "Location zone:\n * `z0` - US States \"CT\", \"ME\", \"MA\", \"NH\", \"NJ\", \"RI\", \"VT\"\n * `z1` - US States \"DE\", \"NY\", \"PA\"\n * `z2` - US States \"MD\", \"NC\", \"SC\", \"VA\", \"WV\"\n * `z3` - US States \"AL\", \"FL\", \"GA\", \"MS\", \"TN\"\n * `z4` - US States \"IN\", \"KY\", \"MI\", \"OH\"\n * `z5` - US States \"IA\", \"MN\", \"MT\", \"ND\", \"SD\", \"WI\"\n * `z6` - US States \"IL\", \"KS\", \"MO\", \"NE\"\n * `z7` - US States \"AR\", \"LA\", \"OK\", \"TX\"\n * `z8` - US States \"AZ\", \"CO\", \"ID\", \"NV\", \"NM\", \"UT\", \"WY\"\n * `z9` - US States \"CA\", \"OR\", \"WA\", \"AK\"\n * `ze` - Canadian Provinces \"NB\", \"NL\", \"NS\", \"PE\"\n * `zc` - Canadian Provinces \"ON\", \"QC\"\n * `zw` - Canadian Provinces \"AB\", \"BC\", \"MB\", \"SK\"\n * `zm` - All states in Mexico\n", "type": "string", "enum": [ "z0", "z1", "z2", "z3", "z4", "z5", "z6", "z7", "z8", "z9", "ze", "zc", "zw", "zm" ], "example": "z6" }, "coordinate": { "description": "Location coordinates", "type": "object", "properties": { "lat": { "description": "Latitude", "type": "number", "format": "float", "example": 41.885681445390645 }, "lon": { "description": "Longitude", "type": "number", "format": "float", "example": -87.6366874973939 } }, "required": [ "lat", "lon" ] } }, "required": [ "city", "stateOrProvince", "postalCode", "country", "zone", "coordinate" ] }, "serviceWindow": { "description": "Service window. Date-times are local to the stop location", "type": "object", "properties": { "start": { "description": "Start date-time of the service window", "type": "string", "format": "date-time", "example": "2021-01-21T07:32:28-6:00" }, "end": { "description": "End date-time of the service window", "type": "string", "format": "date-time", "example": "2021-01-21T07:32:28-6:00" }, "timezone": { "description": "Timezone abbreviation", "type": "string", "nullable": true, "example": "CST" } }, "required": [ "start", "end", "timezone" ] } }, "required": [ "stopNumber", "stopType", "location", "serviceWindow" ] } }, "distance": { "description": "Total loaded distance", "type": "object", "properties": { "value": { "description": "Loaded distance value", "type": "integer", "format": "int32", "example": 400 }, "units": { "description": "Distance units:\n * `mi` - Miles\n * `km` - Kilometers\n", "type": "string", "enum": [ "mi", "km" ], "default": "mi", "example": "mi" } }, "required": [ "value", "units" ] }, "weight": { "description": "Total loaded weight", "type": "object", "properties": { "value": { "description": "Total loaded weight", "type": "integer", "format": "int32", "example": 4000 }, "units": { "description": "Weight units:\n * `lb` - Pound\n * `kg` - Kilogram\n", "type": "string", "enum": [ "lb", "kg" ], "default": "lb", "example": "lb" } }, "required": [ "value", "units" ] }, "specialServices": { "description": "Load special services", "type": "object", "properties": { "hazmat": { "description": "Hazardous Materials", "type": "boolean", "nullable": true, "example": true }, "dropReceiver": { "description": "Drop Trailer Receiver", "type": "boolean", "default": false, "example": true }, "dropShipper": { "description": "Drop Trailer Shipper", "type": "boolean", "default": false, "example": true }, "temp": { "description": "Temperature Requirements", "type": "boolean", "default": false, "example": true }, "straps": { "description": "Requires Straps", "type": "boolean", "default": false, "example": true }, "loadBar": { "description": "Requires Load Bar", "type": "boolean", "default": false, "example": true }, "freeze": { "description": "Protect From Freeze", "type": "boolean", "default": false, "example": true }, "tanker": { "description": "Tanker Endorsement", "type": "boolean", "default": false, "example": true }, "tarps": { "description": "Requires tarps", "type": "boolean", "default": false, "example": true }, "od": { "description": "Over Dimensional", "type": "boolean", "default": false, "example": true }, "assist": { "description": "Driver Assist", "type": "boolean", "default": false, "example": true }, "twic": { "description": "TWIC Card", "type": "boolean", "default": false, "example": true }, "team": { "description": "Team Services", "type": "boolean", "default": false, "example": true } } }, "rate": { "description": "Load rate", "type": "object", "nullable": true, "properties": { "value": { "description": "Rate value", "type": "integer", "format": "int32", "minimum": 0, "example": 1000 }, "currency": { "description": "Rate currency:\n * `USD` - United States Dollar\n", "type": "string", "enum": [ "USD" ], "default": "USD", "example": "USD" } }, "required": [ "value", "currency" ] }, "echoDriveDeepLink": { "description": "EchoDrive Deep Link", "type": "object", "nullable": true, "properties": { "url": { "description": "A link to open/book the load in EchoDrive", "type": "string", "example": "https://echodrive.echo.com/v2/carrier/$/availableLoads/YK2v1bX_bL4Fd-pdIVu6WuJ-JBoDumSLO6MQ5bOy2xyz" }, "message": { "description": "A message describing success/failure", "type": "string", "example": "Success" } }, "required": [ "value", "currency" ] }, "commodity": { "description": "Load commodities", "type": "array", "items": { "description": "Commodity", "type": "string", "example": "boxes" } } }, "required": [ "loadId", "equipment", "mode", "stops", "distance", "weight", "specialServices", "rate", "commodity" ] } } }, "required": [ "resultSet", "loads" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Request", "detail": "The request contained errors and could not be processed.", "status": 400, "errors": [] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Unauthorized", "detail": "The request is unauthorized.", "status": 401 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "description": "Forbidden response", "type": "object", "properties": { "message": { "description": "Error message.", "type": "string", "example": "Forbidden" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Found", "detail": "The requested route has not been found: METHOD - /some/path", "status": 404 } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Method Not Allowed", "detail": "The HTTP method is not allowed on the requested route: METHOD - /some/path", "status": 405 } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Internal Server Error", "detail": "An unknown error has occurred.", "status": 500 } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Implemented", "detail": "The requested route has not been implemented: METHOD - /some/path", "status": 501 } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Gateway", "detail": "The upstream server sent an invalid response.", "status": 502, "errors": [] } } } } } } }, "/v1/bid": { "post": { "operationId": "v1_bidPost", "summary": "Post a bid on a load", "description": "Post a bid on an Available Load. The Name and Email address of the person placing the bid are required.", "tags": [ "Bidding" ], "security": [ { "amazon_api_gateway_authorizer_loads_action": [] } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Post bid request", "type": "object", "required": [ "loadId", "bidAmount", "bidContact" ], "properties": { "loadId": { "type": "string", "description": "Echo load id" }, "note": { "type": "string", "nullable": true, "description": "Note to be displayed in confirmation email" }, "bidAmount": { "type": "number", "format": "float", "minimum": 0.01, "multipleOf": 0.01, "description": "The amount for which the bid will be placed" }, "bidContact": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the contact person for this bid" } }, "anyOf": [ { "required": [ "email" ], "properties": { "email": { "type": "string", "description": "Email of the contact person for this bid" } } }, { "required": [ "phoneNumber" ], "properties": { "phoneNumber": { "type": "string", "description": "Phone number of the contact person for this bid" } } } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Place bid response", "type": "object", "required": [ "truckloadBidKey" ], "properties": { "truckloadBidKey": { "type": "string", "description": "The unique key of the truckload bid that has been accepted" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Request", "detail": "The request contained errors and could not be processed.", "status": 400, "errors": [] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Unauthorized", "detail": "The request is unauthorized.", "status": 401 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "description": "Forbidden response", "type": "object", "properties": { "message": { "description": "Error message.", "type": "string", "example": "Forbidden" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Found", "detail": "The requested route has not been found: METHOD - /some/path", "status": 404 } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Method Not Allowed", "detail": "The HTTP method is not allowed on the requested route: METHOD - /some/path", "status": 405 } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Internal Server Error", "detail": "An unknown error has occurred.", "status": 500 } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Implemented", "detail": "The requested route has not been implemented: METHOD - /some/path", "status": 501 } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Gateway", "detail": "The upstream server sent an invalid response.", "status": 502, "errors": [] } } } } } } }, "/v1/booking": { "post": { "operationId": "v1_bookingPost", "summary": "Post a booking on a load", "description": "Post a booking on an Available Load. Name and Email are required.", "tags": [ "Booking" ], "security": [ { "amazon_api_gateway_authorizer_loads_action": [] } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Post booking request", "type": "object", "required": [ "loadId", "bookingAmount", "bookingContact", "emptyCity", "equipmentType" ], "properties": { "loadId": { "type": "string", "description": "Echo load id" }, "bookingAmount": { "type": "number", "format": "float", "minimum": 0.01, "multipleOf": 0.01, "description": "The amount for which the bid will be placed" }, "bookingContact": { "type": "object", "required": [ "name", "email" ], "properties": { "name": { "type": "string", "description": "Name of the contact person for this booking" }, "email": { "type": "string", "description": "Email of the contact person for this booking" }, "faxNumber": { "type": "string", "description": "Fax number of the contact person for this booking" }, "phoneNumber": { "type": "string", "description": "Phone number of the contact person for this booking" } } }, "emptyCity": { "type": "object", "required": [ "city", "state", "countryCode" ], "properties": { "city": { "type": "string", "description": "Empty city - city" }, "state": { "type": "string", "description": "Empty city - state", "minLength": 2, "maxLength": 2 }, "countryCode": { "type": "string", "description": "Empty city - country code", "minLength": 2, "maxLength": 2 } } }, "equipmentType": { "type": "string", "enum": [ "van_dry_53", "reefer_53", "flatbed_53", "van_dry_48", "reefer_48", "flatbed_48", "box_50", "box_60", "container_chassis_53", "flat_rack_container_20", "flat_rack_container_40", "high_cube_container", "insulated_container_20", "insulated_container_40", "insulated_container_45", "insulated_container_48", "insulated_container_53", "lcl", "open_top_container_20", "open_top_container_40", "refrigerated_container_20", "refrigerated_container_40", "refrigerated_container_45", "refrigerated_container_48", "refrigerated_container_53", "container_20", "container_40", "container_45", "container_48", "container_53", "tank_container_20", "b_train", "conestoga_48", "conestoga_53", "double_drop_deck", "extendable_flatbed", "extendable_rgn", "extendable_step_deck", "flatbed_hotshot", "flatbed_side", "landoll_flatbed", "lowboy", "multi_axle_heavy_haulers", "maxi", "removable_goose_neck", "step_deck_conestoga_48", "step_deck_conestoga_53", "auto_carrier", "air", "animal_carrier", "boat_hauling_trailer", "chassis_only", "cargo_van", "dump_truck", "hopper_bottom", "power_only", "chassis_only_super", "sprinter_van", "straight_truck", "chassis_only_tri_axle", "step_deck_48", "step_deck_53", "aluminum_tanker", "pneumatic_tanker", "tanker", "trailer_48", "trailer_53", "steel_tanker", "curtain_van_48", "curtain_van_53", "double_pup", "straight_hotshot_van_20", "straight_hotshot_van_24", "straight_hotshot_van_28", "straight_hotshot_van_40", "insulated_van_48", "insulated_van_53", "logistics_van_48", "logistics_van_53", "moving_van", "open_top_van_48", "open_top_van_53", "plated_van_48", "plated_van_53", "triple_pup", "van_liftgate_48", "van_liftgate_53", "vented_van_48", "vented_van_53", "walking_floor_van" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Place booking response", "type": "object", "required": [ "truckloadBookingKey" ], "properties": { "truckloadBookingKey": { "type": "string", "description": "The unique key of the truckload booking that has been accepted" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Request", "detail": "The request contained errors and could not be processed.", "status": 400, "errors": [] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Unauthorized", "detail": "The request is unauthorized.", "status": 401 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "description": "Forbidden response", "type": "object", "properties": { "message": { "description": "Error message.", "type": "string", "example": "Forbidden" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Found", "detail": "The requested route has not been found: METHOD - /some/path", "status": 404 } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Method Not Allowed", "detail": "The HTTP method is not allowed on the requested route: METHOD - /some/path", "status": 405 } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Internal Server Error", "detail": "An unknown error has occurred.", "status": 500 } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Not Implemented", "detail": "The requested route has not been implemented: METHOD - /some/path", "status": 501 } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "description": "An Problem Details error response, based on https://datatracker.ietf.org/doc/html/rfc7807", "type": "object", "properties": { "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "type": "number", "format": "int32" }, "errors": { "description": "An object or array of error objects indicating the problem.", "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "title", "detail", "status" ] }, "example": { "title": "Bad Gateway", "detail": "The upstream server sent an invalid response.", "status": 502, "errors": [] } } } } } } } }, "components": { "securitySchemes": { "amazon_api_gateway_authorizer_loads_read": { "type": "apiKey", "name": "Authorization", "in": "header" }, "amazon_api_gateway_authorizer_loads_action": { "type": "apiKey", "name": "Authorization", "in": "header" } } } }