Skip to content
Last updated

Getting Started

Prerequisites

Before you begin integration:

  1. Contact EchoSync Integrations API at IntegrationsAPI@echo.com to obtain API credentials (client_id and client_secret)
  2. Obtain an OAuth 2.0 Bearer token via the Authorizer API
  3. Ensure your system can make HTTPS REST API calls with JSON payloads
  4. Review the OpenAPI specification for complete endpoint details

API Endpoints

Available Loads

Both versions accept identical request bodies and query parameters. See V1 vs V2 for response differences.

MethodEndpointPurpose
POST/v2/availableloadsSearch available loads — recommended
POST/v1/availableloadsSearch available loads (legacy)

Required query parameters: offset (integer, minimum 0), limit (integer, 10–100 in increments of 10)

Bidding and Booking

MethodEndpointPurpose
POST/v1/bidPlace a bid on an available load
POST/v1/bookingBook an available load

V1 vs V2 Available Loads

V2 is recomended. It returns everything V1 does, plus an echoDriveDeepLink for each load. New integrations should start with V2.

AspectV1V2
RequestIdenticalIdentical
ResponseNot includedechoDriveDeepLink URL included per load
RecommendationLegacyRecommended

Typical Carrier Workflow

Search and Bid

  1. Search loads - POST to /v2/availableloads with your search criteria
  2. Review results - Inspect returned loads with pricing, stops, equipment, and special services
  3. Place a bid - POST to /v1/bid with loadId, bidAmount, and bidContact
  4. Receive confirmation - Response includes truckloadBidKey

Search and Book

  1. Search loads - POST to /v2/availableloads
  2. Book a load - POST to /v1/booking with loadId, bookingAmount, bookingContact, emptyCity, and equipmentType
  3. Receive confirmation - Response includes truckloadBookingKey

Available loads results are paginated using query parameters:

ParameterRequiredDescription
offsetYesNumber of results to skip (minimum 0)
limitYesPage size: minimum 10, maximum 100, must be a multiple of 10

The response resultSet object contains count, offset, limit, and total for navigating pages.