Skip to content
Last updated

General Overview

Prerequisites

Before you begin integration:

  1. Contact your Echo account team to obtain your UserName (ENumber) and APIKey
  2. Ensure your system can make HTTPS REST API calls with JSON payloads
  3. Review the OpenAPI specification for complete request/response schemas

API Endpoints

All endpoints use base URL https://restapi.echo.com unless noted.

Rates

MethodEndpointOperation
POST/v2/ratesGet LTL carrier rates, transit days, and guaranteed options
POST/v2/rates/summaryGet a filtered summary of LTL carrier rates

Shipment Creation

MethodEndpointOperation
POST/v2/shipments/LTLCreate an LTL shipment
POST/v2/shipments/TLCreate a TL shipment
POST/v2/shipments/PLCreate a partial load shipment

Shipment Status and Tracking

MethodEndpointOperation
GET/v2/shipments/{ShipmentId}Get status for a single shipment
GET/v2/shipments/statusesGet status for up to 25 shipments
GET/v2/shipments/{ShipmentId}/trackingGet tracking events for a shipment

Shipment Details and Documents

MethodEndpointOperation
POST/v2/query/shipmentdetailGet full shipment details
POST/v2/query/shipmentsSearch shipments
GET/v2/shipments/{ShipmentId}/documentsList available documents
GET/v2/shipments/{ShipmentId}/documents/{type}Retrieve a specific document
GET/v2/shipments/{ShipmentId}/costGet shipment cost breakdown

Update and Cancel (prod_int.echo.com)

These endpoints use base URL https://prod_int.echo.com and match the original Create request structure, identified by BOL number.

MethodEndpointOperation
POST/Shipments/LTL/Update/Service.svcUpdate an LTL shipment
POST/Shipments/TL/Update/Service.svcUpdate a TL shipment
POST/Shipments/LTL/Cancel/Service.svcCancel an LTL shipment
POST/Shipments/TL/Cancel/Service.svcCancel a TL shipment

Recomended Workflow

Rate and Create Shipment (LTL)

  1. Get rates — POST to /v2/rates with origin/destination zip codes, weight, and freight class
  2. Select a rate — Choose a carrier SCAC and guarantee option from the response
  3. Create shipment — POST to /v2/shipments/LTL with the selected carrier and full shipment details
  4. Receive Echo Load ID — The ShipmentId in the response is your reference for all subsequent calls

Track Shipment and Access Documents

  1. Check status — GET /v2/shipments/{ShipmentId} for current status
  2. Get tracking — GET /v2/shipments/{ShipmentId}/tracking for event history
  3. Retrieve documents — GET /v2/shipments/{ShipmentId}/documents once the shipment is booked; BOL, POD, and Invoice are available when loaded in Echo's system

Update and Cancel Rules

  • The JSON request body must match the original Create request structure
  • Echo matches the update or cancel to the existing load by BolNumber
  • The original BolNumber must be present in both the existing load and the update/cancel request
  • For TL updates: Accessorials, EquipmentType, EquipmentAccessorials, EquipmentTarps, EquipmentNotes, and CubicSize are not eligible for update. Please reach out to your Echo account representative.