{"openapi":"3.0.3","info":{"contact":{"name":"Echo Global Logistics","url":"https://www.echo.com","email":"carrierintegrations@echo.com"},"version":"2.24.0222","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 [**Echo Authorizer API**](https://app.swaggerhub.com/apis-docs/echogl/Echo_Authorizer_Public/) for information on using authorization."},"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."},{"name":"Health","description":"Operations providing reports on services' health status."}],"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: Equipment, Origin/Destination State or States, Origin/Destination Zone or Zones, Pickup Date(s), Distance, Weight, Special Services (Hazmat, Team, Temperature).","tags":["AvailableLoads"],"security":[{"amazon_api_gateway_authorizer_loads_read":[]}],"parameters":[{"required":true,"name":"offset","in":"query","schema":{"type":"integer","format":"int32","minimum":0,"example":20},"description":"The number of loads to skip before starting to collect the result set"},{"required":true,"name":"limit","in":"query","schema":{"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"}],"requestBody":{"content":{"application/json":{"schema":{"description":"Available loads request","type":"object","properties":{"origin":{"description":"Search by load origin","anyOf":[{"type":"object","properties":{"city":{"type":"string","minLength":2,"example":"Chicago"},"stateOrProvince":{"type":"string","minLength":2,"example":"IL"}},"required":["city","stateOrProvince"]},{"type":"object","properties":{"statesOrProvinces":{"type":"array","items":{"type":"string"},"example":["IL","WI"]}},"required":["statesOrProvinces"]},{"type":"object","properties":{"zone":{"type":"string","enum":["z0","z1","z2","z3","z4","z5","z6","z7","z8","z9","ze","zc","zw","zm"],"example":"z6"}},"required":["zone"]},{"type":"object","properties":{"zones":{"type":"array","items":{"type":"string"},"example":["z1","z2"]}},"required":["zones"]}]},"destination":{"description":"Search by load destination","anyOf":[{"type":"object","properties":{"city":{"type":"string","minLength":2,"example":"Chicago"},"stateOrProvince":{"type":"string","minLength":2,"example":"IL"}},"required":["city","stateOrProvince"]},{"type":"object","properties":{"statesOrProvinces":{"type":"array","items":{"type":"string"}}},"required":["statesOrProvinces"]},{"type":"object","properties":{"zone":{"type":"string","enum":["z0","z1","z2","z3","z4","z5","z6","z7","z8","z9","ze","zc","zw","zm"]}},"required":["zone"]},{"type":"object","properties":{"zones":{"type":"array","items":{"type":"string"}}},"required":["zones"]}]},"pickupDate":{"description":"Search by pickup dates","type":"array","uniqueItems":true,"items":{"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":{"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":{"type":"array","items":{"type":"string","enum":["flatbed","reefer","van","van_dry_53","reefer_53","flatbed_53","van_dry_48","reefer_48","flatbed_48"]}},"mode":{"type":"string","enum":["tl"],"default":"tl"},"distance":{"type":"object","properties":{"min":{"type":"integer","format":"int32","default":0},"max":{"type":"integer","format":"int32"},"units":{"type":"string","enum":["mi","km"],"default":"mi"}},"required":["max"]},"weight":{"type":"object","properties":{"min":{"type":"integer","format":"int32","default":0},"max":{"type":"integer","format":"int32"},"units":{"type":"string","enum":["lb","kg"],"default":"lb"}},"required":["max"]},"specialServices":{"type":"object","properties":{"hazmat":{"type":"boolean","default":true},"temp":{"type":"boolean","default":true},"team":{"type":"boolean","default":true}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Available loads response","type":"object","properties":{"resultSet":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}}},"loads":{"type":"array","items":{"type":"object","properties":{"loadId":{"type":"string","example":"6239230"},"equipment":{"type":"array","items":{"type":"string"}},"mode":{"type":"string","enum":["tl"]},"stops":{"type":"array","minItems":2,"items":{"type":"object","properties":{"stopNumber":{"type":"integer","format":"int32"},"stopType":{"type":"string","enum":["pick","drop"]},"location":{"type":"object","properties":{"city":{"type":"string"},"stateOrProvince":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string","enum":["USA","CAN","MEX"]},"zone":{"type":"string"},"coordinate":{"type":"object","properties":{"lat":{"type":"number","format":"float"},"lon":{"type":"number","format":"float"}}}}},"serviceWindow":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"timezone":{"type":"string","nullable":true}}}}}},"distance":{"type":"object","properties":{"value":{"type":"integer","format":"int32"},"units":{"type":"string","enum":["mi","km"]}}},"weight":{"type":"object","properties":{"value":{"type":"integer","format":"int32"},"units":{"type":"string","enum":["lb","kg"]}}},"specialServices":{"type":"object","properties":{"hazmat":{"type":"boolean"},"dropReceiver":{"type":"boolean"},"dropShipper":{"type":"boolean"},"temp":{"type":"boolean"},"team":{"type":"boolean"}}},"rate":{"type":"object","nullable":true,"properties":{"value":{"type":"integer","format":"int32"},"currency":{"type":"string","enum":["USD"]}}},"commodity":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/v2/availableloads":{"post":{"operationId":"v2_availableloads","summary":"Search available loads.","description":"Search Available Loads V2 returns EchoDrive deep links in addition to load details.","tags":["AvailableLoads"],"security":[{"amazon_api_gateway_authorizer_loads_read":[]}],"parameters":[{"required":true,"name":"offset","in":"query","schema":{"type":"integer","format":"int32","minimum":0}},{"required":true,"name":"limit","in":"query","schema":{"type":"integer","format":"int32","multipleOf":10,"minimum":10,"maximum":100}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Available loads request","type":"object","properties":{"equipment":{"type":"string","enum":["flatbed","reefer","van","van_dry_53","reefer_53","flatbed_53","van_dry_48","reefer_48","flatbed_48"]},"mode":{"type":"string","enum":["tl"],"default":"tl"},"pickupDate":{"type":"array","items":{"type":"string","format":"date"}}}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}}}},"/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},"bidAmount":{"type":"number","format":"float","minimum":0.01,"multipleOf":0.01},"bidContact":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["truckloadBidKey"],"properties":{"truckloadBidKey":{"type":"string","description":"The unique key of the truckload bid that has been accepted"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/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"},"bookingAmount":{"type":"number","format":"float","minimum":0.01,"multipleOf":0.01},"bookingContact":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string"},"email":{"type":"string"},"faxNumber":{"type":"string"},"phoneNumber":{"type":"string"}}},"emptyCity":{"type":"object","required":["city","state","countryCode"],"properties":{"city":{"type":"string"},"state":{"type":"string","minLength":2,"maxLength":2},"countryCode":{"type":"string","minLength":2,"maxLength":2}}},"equipmentType":{"type":"string","enum":["van_dry_53","reefer_53","flatbed_53","van_dry_48","reefer_48","flatbed_48","cargo_van","sprinter_van","straight_truck","step_deck_48","step_deck_53","flatbed_48","lowboy","power_only"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["truckloadBookingKey"],"properties":{"truckloadBookingKey":{"type":"string","description":"The unique key of the truckload booking that has been accepted"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}},"components":{"securitySchemes":{"amazon_api_gateway_authorizer_loads_read":{"type":"apiKey","name":"Authorization","in":"header","x-amazon-apigateway-authtype":"custom"},"amazon_api_gateway_authorizer_loads_action":{"type":"apiKey","name":"Authorization","in":"header","x-amazon-apigateway-authtype":"custom"}}}}