Updating a Carrier Relationship

When using the GET for a carrier relationship, users can either choose to GET all relationships or to GET a single relationship using a FreightHaulerIdentifierName. Both options are described below.

The HTTP Endpoint for shipment retrieval is listed below:

HTTP Verb: GET
URI: /atlas/frexapi/relationship
Authentication: Basic Auth or Bearer Token

Success Response:

[
    {
        "FreightHaulerName": "TEST Carrier",
        "FreightHaulerProviderXID": "MP_Carrier",
        "FreightHaulerIdentifiers": [
            {
                "FreightHaulerIdentifierId": 4,
                "FreightHaulerIdentifierName": "ABCD",
                "FreightHaulerIdentifierType": 3,
                "FreightHaulerIdentifierTypeName": "SCACCode"
            }
        ]
    },
    {
        "FreightHaulerName": "Freight Hauler 1",
        "FreightHaulerProviderXID": "TESTXID20191111",
        "FreightHaulerIdentifiers": [
            {
                "FreightHaulerIdentifierId": 26387,
                "FreightHaulerIdentifierName": "TEST",
                "FreightHaulerIdentifierType": 1,
                "FreightHaulerIdentifierTypeName": "MCNumber"
            }
        ]
    }
]

GET Relationship by FreightHaulerIdentifierName uses all of the same information above, but with a query string parameter.

HTTP Verb: GET
URI: /atlas/frexapi/relationship?identifierName={FreightHaulerIdentifierName}
Authentication: Requires a valid 10-4 bearer token