{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-carrier-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Response Status Codes"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"response-status-codes","__idx":0},"children":["Response Status Codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status Code"},"children":["Status Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint(s)"},"children":["Endpoint(s)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request was successfully processed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request cannot be processed due to validation errors. Check the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," field for specific failures."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication credentials are missing or invalid. Verify the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer {token}"]}," header."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid credentials provided but the account lacks the required scope. Verify ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loads:read"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loads:action"]}," scope is provisioned."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The requested route or resource does not exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500 Internal Server Error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An internal error occurred. Retry the request. If the issue persists, contact support with error details and timestamps."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["502 Bad Gateway"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The server received an invalid response from an upstream service. Retry the request."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-resolution-steps","__idx":1},"children":["Common Resolution Steps"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"400-bad-request","__idx":2},"children":["400 Bad Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Invalid equipment value:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify the value is from the allowed enum list and is lowercase: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["van_dry_53"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reefer_53"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flatbed_48"]},", etc."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Invalid pickup date format:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]}," format: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2025-12-01"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Invalid deadhead value:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Maximum value is 300. Units must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mi"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["km"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Missing required booking fields:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingContact"]}," requires both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emptyCity"]}," requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," (2 chars), and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}," (2 chars)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["equipmentType"]}," must be a valid value from the booking equipment list"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"401-unauthorized","__idx":3},"children":["401 Unauthorized"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request a new access token via the Authorizer API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify the header is formatted as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer {token}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm credentials are correct"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"403-forbidden","__idx":4},"children":["403 Forbidden"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify your token was issued with the correct scope:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loads:read"]}," for search endpoints"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loads:action"]}," for bid and booking endpoints"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Contact Echo Support Team to verify scope provisioning"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-response-format","__idx":5},"children":["Error Response Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All error responses follow ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7807"},"children":["RFC 7807 Problem Details"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Short, human-readable summary of the problem"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable explanation specific to this occurrence"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP status code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object or array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specific validation errors or problem details"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"title\": \"Bad Request\",\n  \"detail\": \"The request contained errors and could not be processed.\",\n  \"status\": 400,\n  \"errors\": [...]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"successful-response-shapes","__idx":6},"children":["Successful Response Shapes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"available-loads","__idx":7},"children":["Available Loads"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example below is a V2 response. V1 responses are identical but omit the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["echoDriveDeepLink"]}," field."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"resultSet\": {\n    \"count\": 1,\n    \"limit\": 10,\n    \"offset\": 0,\n    \"total\": 50\n  },\n  \"loads\": [\n    {\n      \"loadId\": \"47141442\",\n      \"equipment\": [\"van_dry_53\", \"flatbed_53\"],\n      \"mode\": \"tl\",\n      \"stops\": [\n        {\n          \"stopNumber\": 1,\n          \"stopType\": \"pick\",\n          \"location\": {\n            \"city\": \"EDEN\",\n            \"stateOrProvince\": \"NC\",\n            \"postalCode\": \"27289\",\n            \"country\": \"USA\",\n            \"zone\": \"z2\",\n            \"coordinate\": {\n              \"lat\": 36.5017509460449,\n              \"lon\": -79.7486190795898\n            }\n          },\n          \"serviceWindow\": {\n            \"start\": \"2021-11-03T14:00:00-04:00\",\n            \"end\": \"2021-11-03T14:00:00-04:00\",\n            \"timezone\": \"EDT\"\n          }\n        },\n        {\n          \"stopNumber\": 2,\n          \"stopType\": \"drop\",\n          \"location\": {\n            \"city\": \"BREINIGSVILLE\",\n            \"stateOrProvince\": \"PA\",\n            \"postalCode\": \"18031\",\n            \"country\": \"USA\",\n            \"zone\": \"z1\",\n            \"coordinate\": {\n              \"lat\": 40.5545692443848,\n              \"lon\": -75.6406097412109\n            }\n          },\n          \"serviceWindow\": {\n            \"start\": \"2021-11-16T09:00:00-05:00\",\n            \"end\": \"2021-11-16T09:00:00-05:00\",\n            \"timezone\": \"EST\"\n          }\n        }\n      ],\n      \"distance\": {\n        \"value\": 0,\n        \"units\": \"mi\"\n      },\n      \"weight\": {\n        \"value\": 18144,\n        \"units\": \"kg\"\n      },\n      \"specialServices\": {\n        \"assist\": false,\n        \"dropReceiver\": false,\n        \"dropShipper\": false,\n        \"freeze\": false,\n        \"hazmat\": true,\n        \"loadBar\": false,\n        \"od\": false,\n        \"straps\": false,\n        \"tanker\": false,\n        \"tarps\": false,\n        \"team\": false,\n        \"temp\": false,\n        \"twic\": false\n      },\n      \"rate\": {\n        \"value\": 650,\n        \"currency\": \"USD\"\n      },\n      \"echoDriveDeepLink\": {\n        \"url\": \"https://echodrive.echo.com/v2/carrier/$/availableLoads/YK2v1bX_bL4Fd-pdIVu6WuJ-JBoDumSLO6MQ5bOy2xyz\",\n        \"message\": null\n      },\n      \"commodity\": [\"M1128 Plastic Chipboard 44x56-\"]\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"bid-response","__idx":8},"children":["Bid Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"truckloadBidKey\": \"abc123...\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"booking-response","__idx":9},"children":["Booking Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"truckloadBookingKey\": \"xyz789...\"\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Response Status Codes","id":"response-status-codes","depth":1},{"value":"Common Resolution Steps","id":"common-resolution-steps","depth":2},{"value":"400 Bad Request","id":"400-bad-request","depth":3},{"value":"401 Unauthorized","id":"401-unauthorized","depth":3},{"value":"403 Forbidden","id":"403-forbidden","depth":3},{"value":"Error Response Format","id":"error-response-format","depth":2},{"value":"Successful Response Shapes","id":"successful-response-shapes","depth":2},{"value":"Available Loads","id":"available-loads","depth":3},{"value":"Bid Response","id":"bid-response","depth":3},{"value":"Booking Response","id":"booking-response","depth":3}],"frontmatter":{"id":"response-reference","title":"Response Reference Guide","seo":{"title":"Response Status Codes"}},"lastModified":"2026-10-15T20:14:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/carrier-api/response-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}