Carrier Relationship Services endpoint allows the management of carrier relationships for an organization with a POST, PUT, and GET calls.

📘
Before posting any shipments, at least one carrier relationship is required.

Adding a Carrier Relationship

HTTP Verb: POST
URI: /atlas/frexapi/relationship
Authorization: Basic Auth or Bearer Token

To create a basic carrier relationship in Freight Portal, the following information is required:

Parameter	Type	Description
FreightHaulerName	String	External reference number of the shipment's BOL.
FreightHaulerProviderXID	String	Unique ID that ties a carrier to a shipper.
FreightHaulerIdentifierName	String	Value for either SCAC, MC, or DOT based on which FreightHaulerIdentifierType is selected.
FreightHaulerIdentifierType	Integer	The type of unique carrier reference the carrier would like to use such as SCAC, MC, or DOT. FreightHaulerIdentifierType

Sample Object:

{
    "FreightHaulerName": "Freight Hauler 1",
    "FreightHaulerProviderXID": "TESTXID20191111",
    "FreightHaulerIdentifierName": "TEST",
    "FreightHaulerIdentifierType": 1
}

Sample Response:

{
    "FreightHaulerName": "Freight Hauler 1",
    "FreightHaulerProviderXID": "TESTXID20191111",
    "FreightHaulerIdentifiers": [
        {
            "FreightHaulerIdentifierId": 26387,
            "FreightHaulerIdentifierName": "TEST",
            "FreightHaulerIdentifierType": 1,
            "FreightHaulerIdentifierTypeName": "MCNumber"
        }
    ]
}