Site Logo

Update LTL Carrier Accounts

ShipEngine API provides the ability to update the connection information for your connected LTL carriers. This allows you to update your authentication information without disconnecting and reconnecting the carrier.

Request Format

This request requires the carrier_code and the carrier_id be passed in the URL to indicate to ShipEngine which carrier connection you wish to update.

Each LTL carrier uses its own format for authentication, so the information your application must pass to connect an account through ShipEngine API depends on the carrier.

You can find the requirements for connecting each LTL carrier available through ShipEngine API, including the credential requirements, on our Connect Carrier Accounts page. Additionally, you can list the credential requirements for a specific carrier.

Carrier Codes

In the request below, you will need to know the carrier code for your LTL carrier. This code will be passed in the URL as a query string. This is what tells ShipEngine API which carrier you are connecting.

The carrier codes are mapped to the carriers' SCACs, and many carriers have more than one. The SCACs may correspond to different services or other arrangements that the carrier offers. For more information about the individual SCACs listed, contact the carrier.

To see a list of LTL carriers and their corresponding SCAC, visit the Connect Carrier Accounts page.

Carrier IDs

Each of your LTL carriers has a unique carrier_id in ShipEngine. This ID represents your connection with a specific carrier, and it is generated and returned when you connect a carrier account. You can use this carrier_id for many other ShipEngine endpoints to indicate which account to use.

See below for a sample request using generic authentication.

Example Request

PUT /v-beta/ltl/connections/:carrier_code/:carrier_id

PUT /v-beta/ltl/connections/FXFE/6d989d94-0eb2-41cc-a0da-3f476a17d1b4 HTTP/1.1
API-Key: TEST_4HaHGNPNK8kdwhWpT13Wj7lvAaij36HxQ/2sFeC0czY
Content-Type: application/json
"credentials": {
"key": "The key provided by the carrier.",
"account_number": "The account number for your account with the carrier."

Example Response

"carrier_id": "aed2a8c0-7998-4fef-9a82-2cab5f527dc2"