Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Carriers

Retrieve a Carrier

View a carrier within the specified account.

get/public/v3/Carriers/{carrierId}

Path parameters

carrierIdstring uuid required

ID of the carrier.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested carrier

carrierIdstring uuid
accountIdinteger
namestring nullable
mode'Road' | 'Ocean' | 'Air' | 'Rail'

The mode of transportation. Valid modes are Road, Ocean, Air, or Rail.

standardizedCarrierIdstring uuid
standardizedCarrierNamestring nullable
areaOfOperation'UnitedStates' | 'RestOfTheWorld'

Area of Operation of the Carrier. Valid values are UnitedStates, RestOfTheWorld.

dotNumberstring nullable
mcNumberstring nullable