Carriers can be added to each leg of a shipment if desired. The Tive public API provides the ability to create, update, view a specific carrier, or view a list of carriers with the public API.

When creating or updating a carrier the following fields must be specified:

• Name: The unique name of your carrier
• Mode: Road, Ocean, Air, or Rail
• Standardized Carrier Id

Additionally, if you typically have a contact you reach out to with a carrier, the API will also allow you to specify one or more carrier contact.

Standardized Carriers

Carrier naming formats can differ when using third party integrations. As such, when creating a carrier via the API or in the Tive platform, you must specify a standardized carrier id. This helps normalize and associate carrier names between Tive and the other provides we use to help provide you shipment visibility.

If you don't see the name of your carrier for a specified transport mode, you can default to the id associated with the standardized carrier name Other for the mode in question. To see a list of standardized carriers, you can use the List Standardized Carriers endpoint.

For example, if I wanted to add the ocean carrier Example Carrier to Tive, I would first make the follow request:

GET https://api.tive.com/public/v3/carriers/standardizedCarriers?mode=Ocean

The response would look something like this:

{
  "totalRecords": 2,
  "pageNumber": 1,
  "pageSize": 50,
  "data": [
    {
      "standardizedCarrierId": "STD_CARRIER_ID_1",
      "standardizedName": "EXAMPLE CARRIER",
      "mode": "Ocean"
    },
    {
      "standardizedCarrierId": "STD_CARRIER_ID_2",
      "standardizedName": "Other",
      "mode": "Ocean"
    }
  ]
}

With the standardizedCarrierId known, you will now be able to create your carrier in Tive by making the following request

POST https://api.tive.com/v3/carriers

{
     "mode": "Ocean",
     "name": "Example Carrier",
     "accountId": 123,
     "standardizedCarrierId": "STD_CARRIER_ID_1"
}

Again, in the case where you can't find your carrier for a specific mode, the standardizedCarrierId associated to the Other standardized name should be used.