{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-shipper-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Shipper API Overview"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"shipper-api-overview","__idx":0},"children":["Shipper API Overview"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The EchoSync Shipper API V2 enables you to create and manage freight shipments, retrieve rates, track loads, and access shipment documents. The API supports Truckload (TL), Less-than-Truckload (LTL), and Partial Load (PL) shipment modes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":2},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://restapi.echo.com/v2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operations (Use this for Update and Cancel requests):"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://prod_int.echo.com"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":3},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API calls require your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["UserName"]}," (ENumber) and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["APIKey"]}," sent as a Basic Authentication header."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Build a string of the form ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UserName:APIKey"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Base64-encode the string"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Basic {base64encodedString}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Basic RTg0Mzc0OjY4M0YzRTU4LThBRUUtNEQ5MC1CRTRBLURDNTRGQkEyMzJEMA==\n"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This API does not use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["EchoSync Auth API"]}," (OAuth/token-based authentication)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Contact your Echo account team to obtain your UserName and APIKey."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"core-concepts","__idx":4},"children":["Core Concepts"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"shipment-id","__idx":5},"children":["Shipment ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ShipmentId"]}," (Echo Load ID) is an 8-digit integer returned by the Create Shipment endpoints. It is required by all downstream get, status, tracking, and document endpoints."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"shipment-modes","__idx":6},"children":["Shipment Modes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TL (Truckload):"]}," Shipments that occupy a full trailer. Requires equipment type selection in the request payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PL (Partial Load):"]}," A truckload-style shipment that shares trailer space. Requires the same fields as TL plus handling unit information."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LTL (Less-than-Truckload):"]}," Shipments routed through a carrier network. Requires handling unit, freight class and NMFC information in the request payload."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"address-validation","__idx":7},"children":["Address Validation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shipper and consignee addresses are validated via Experian and PCMiler. Physical street addresses are required — no P.O. boxes."]}]},"headings":[{"value":"Shipper API Overview","id":"shipper-api-overview","depth":1},{"value":"Introduction","id":"introduction","depth":2},{"value":"Base URL","id":"base-url","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Core Concepts","id":"core-concepts","depth":2},{"value":"Shipment ID","id":"shipment-id","depth":3},{"value":"Shipment Modes","id":"shipment-modes","depth":3},{"value":"Address Validation","id":"address-validation","depth":3}],"frontmatter":{"id":"introduction","title":"Shipper API Introduction","seo":{"title":"Shipper API Overview"}},"lastModified":"2026-06-19T21:40:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/shipper-api/introduction","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}