{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-carrier-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting Started"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":0},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin integration:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Contact EchoSync Integrations API at ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:IntegrationsAPI@echo.com"},"children":["IntegrationsAPI@echo.com"]}," to obtain API credentials (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["client_id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["client_secret"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Obtain an OAuth 2.0 Bearer token via the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/authorizer-api/introduction"},"children":["Authorizer API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure your system can make HTTPS REST API calls with JSON payloads"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Review the OpenAPI specification for complete endpoint details"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-endpoints","__idx":2},"children":["API Endpoints"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"available-loads","__idx":3},"children":["Available Loads"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both versions accept identical request bodies and query parameters. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#v1-vs-v2-available-loads"},"children":["V1 vs V2"]}," for response differences."]},{"$$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":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/availableloads"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search available loads — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["recommended"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/availableloads"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search available loads (legacy)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required query parameters:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}," (integer, minimum 0), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," (integer, 10–100 in increments of 10)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"bidding-and-booking","__idx":4},"children":["Bidding and Booking"]},{"$$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":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/bid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Place a bid on an available load"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/booking"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Book an available load"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"v1-vs-v2-available-loads","__idx":5},"children":["V1 vs V2 Available Loads"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 is recomended."]}," It returns everything V1 does, plus an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["echoDriveDeepLink"]}," for each load. New integrations should start with V2."]},{"$$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":"Aspect"},"children":["Aspect"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V1"},"children":["V1"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identical"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identical"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not included"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["echoDriveDeepLink"]}," URL included per load"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recommendation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Legacy"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recommended"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-carrier-workflow","__idx":6},"children":["Typical Carrier Workflow"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-and-bid","__idx":7},"children":["Search and Bid"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search loads"]}," - POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/availableloads"]}," with your search criteria"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Review results"]}," - Inspect returned loads with pricing, stops, equipment, and special services"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Place a bid"]}," - POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/bid"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loadId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bidAmount"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bidContact"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Receive confirmation"]}," - Response includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["truckloadBidKey"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-and-book","__idx":8},"children":["Search and Book"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search loads"]}," - POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/availableloads"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Book a load"]}," - POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/booking"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loadId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingAmount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingContact"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emptyCity"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["equipmentType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Receive confirmation"]}," - Response includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["truckloadBookingKey"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pagination","__idx":9},"children":["Pagination"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Available loads results are paginated using query parameters:"]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["offset"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results to skip (minimum 0)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page size: minimum 10, maximum 100, must be a multiple of 10"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultSet"]}," object contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["count"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total"]}," for navigating pages."]}]},"headings":[{"value":"Getting Started","id":"getting-started","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"API Endpoints","id":"api-endpoints","depth":2},{"value":"Available Loads","id":"available-loads","depth":3},{"value":"Bidding and Booking","id":"bidding-and-booking","depth":3},{"value":"V1 vs V2 Available Loads","id":"v1-vs-v2-available-loads","depth":2},{"value":"Typical Carrier Workflow","id":"typical-carrier-workflow","depth":2},{"value":"Search and Bid","id":"search-and-bid","depth":3},{"value":"Search and Book","id":"search-and-book","depth":3},{"value":"Pagination","id":"pagination","depth":2}],"frontmatter":{"id":"getting-started","title":"Getting Started","seo":{"title":"Getting Started"}},"lastModified":"2026-10-07T16:53:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/carrier-api/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}