{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-shipper-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"General Overview"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"general-overview","__idx":0},"children":["General Overview"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact your Echo account team"]}," to obtain your UserName (ENumber) and APIKey"]},{"$$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 request/response schemas"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-endpoints","__idx":2},"children":["API Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints use base URL ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://restapi.echo.com"]}," unless noted."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rates","__idx":3},"children":["Rates"]},{"$$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":"Operation"},"children":["Operation"]}]}]},{"$$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/rates"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get LTL carrier rates, transit days, and guaranteed options"]}]},{"$$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/rates/summary"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a filtered summary of LTL carrier rates"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"shipment-creation","__idx":4},"children":["Shipment Creation"]},{"$$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":"Operation"},"children":["Operation"]}]}]},{"$$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/shipments/LTL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create an LTL shipment"]}]},{"$$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/shipments/TL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a TL shipment"]}]},{"$$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/shipments/PL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a partial load shipment"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"shipment-status-and-tracking","__idx":5},"children":["Shipment Status and Tracking"]},{"$$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":"Operation"},"children":["Operation"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get status for a single shipment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/statuses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get status for up to 25 shipments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}/tracking"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get tracking events for a shipment"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"shipment-details-and-documents","__idx":6},"children":["Shipment Details and Documents"]},{"$$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":"Operation"},"children":["Operation"]}]}]},{"$$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/query/shipmentdetail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get full shipment details"]}]},{"$$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/query/shipments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search shipments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}/documents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List available documents"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}/documents/{type}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve a specific document"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}/cost"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get shipment cost breakdown"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-and-cancel-prod_intechocom","__idx":7},"children":["Update and Cancel (prod_int.echo.com)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These endpoints use base URL ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://prod_int.echo.com"]}," and match the original Create request structure, identified by BOL number."]},{"$$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":"Operation"},"children":["Operation"]}]}]},{"$$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":["/Shipments/LTL/Update/Service.svc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update an LTL shipment"]}]},{"$$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":["/Shipments/TL/Update/Service.svc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a TL shipment"]}]},{"$$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":["/Shipments/LTL/Cancel/Service.svc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancel an LTL shipment"]}]},{"$$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":["/Shipments/TL/Cancel/Service.svc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancel a TL shipment"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recomended-workflow","__idx":8},"children":["Recomended Workflow"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rate-and-create-shipment-ltl","__idx":9},"children":["Rate and Create Shipment (LTL)"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get rates"]}," — POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/rates"]}," with origin/destination zip codes, weight, and freight class"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Select a rate"]}," — Choose a carrier SCAC and guarantee option from the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create shipment"]}," — POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/LTL"]}," with the selected carrier and full shipment details"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Receive Echo Load ID"]}," — The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ShipmentId"]}," in the response is your reference for all subsequent calls"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"track-shipment-and-access-documents","__idx":10},"children":["Track Shipment and Access Documents"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check status"]}," — GET ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}"]}," for current status"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get tracking"]}," — GET ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}/tracking"]}," for event history"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Retrieve documents"]}," — GET ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{ShipmentId}/documents"]}," once the shipment is booked; BOL, POD, and Invoice are available when loaded in Echo's system"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update-and-cancel-rules","__idx":11},"children":["Update and Cancel Rules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The JSON request body must match the original Create request structure"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Echo matches the update or cancel to the existing load by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BolNumber"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The original ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BolNumber"]}," must be present in both the existing load and the update/cancel request"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For TL updates: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accessorials"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EquipmentType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EquipmentAccessorials"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EquipmentTarps"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EquipmentNotes"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CubicSize"]}," are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," eligible for update. Please reach out to your Echo account representative."]}]}]},"headings":[{"value":"General Overview","id":"general-overview","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"API Endpoints","id":"api-endpoints","depth":2},{"value":"Rates","id":"rates","depth":3},{"value":"Shipment Creation","id":"shipment-creation","depth":3},{"value":"Shipment Status and Tracking","id":"shipment-status-and-tracking","depth":3},{"value":"Shipment Details and Documents","id":"shipment-details-and-documents","depth":3},{"value":"Update and Cancel (prod_int.echo.com)","id":"update-and-cancel-prod_intechocom","depth":3},{"value":"Recomended Workflow","id":"recomended-workflow","depth":2},{"value":"Rate and Create Shipment (LTL)","id":"rate-and-create-shipment-ltl","depth":3},{"value":"Track Shipment and Access Documents","id":"track-shipment-and-access-documents","depth":3},{"value":"Update and Cancel Rules","id":"update-and-cancel-rules","depth":2}],"frontmatter":{"id":"overview","title":"General Overview","seo":{"title":"General Overview"}},"lastModified":"2026-06-19T21:40:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/shipper-api/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}