Get information about a carrier relationship

SecurityAuthToken
Request
path Parameters
carrierRelationshipId
required
string <uuid>

The id of the vendor relationship

Responses
200

Successfully returned a carrier relationship

Response Schema: application/json
bill_to_vendor_by_default
boolean

Whether or not the vendor requests that they be assigned as the bill-to party when they get tendered loads. Setting is read-only, and will not be present when this object is part of a list.

object (Address)
billing_email
string or null
object or null
object (User)
Array of objects (CarrierReferenceCode)
carrier_status
string or null
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
carrier_status_last_updated
string or null <date-time>
object (SlimUser)
created_at
string or null <date-time>
Array of objects (CarrierDriver)
exclude_from_automated_carrier_status
boolean
external_payment_processor_id
string or null <uuid>
external_payment_processor_sync_status
string or null
Enum: "CURRENT" "SYNC_ERROR"
object (FmcsaCensusData)

FMCSA census vendor data

object (Company)
id
string or null <uuid>
Array of objects
Array of objects (CarrierInsurance)
is_carrier_insurance_compliance_enabled
boolean
is_editable
boolean
object (Address)
name
string or null
notes
string or null
Array of objects (FreightAuthorityVendorRelationshipPaymentTerm)

Payment terms configured for this carrier relationship

Array of objects (CarrierPointOfContact)
primary_email
string or null
primary_phone_number
string or null
object (Company)
Array of objects (CarrierTag)
terms
string or null

Carrier terms and conditions that will be displayed during rate quoting

updated_at
string or null <date-time>
object (VendorFactoringCompany)
allow_dispatching_despite_exclusion_rules
boolean
allow_drivers_sms_shipment_messages
boolean
allow_pre_pro_assignment
boolean
allow_rating_despite_exclusion_rules
boolean
Array of objects (SlimHighwayCarrier)
object (PreProNumberGenerationConfig)
Array of objects (SlimRMISCarrier)
Array of objects (SlimSaferWatchCarrier)
default

Default error response

get/carrier-relationships/{carrierRelationshipId}/
Request samples 
Response samples 
application/json
{
  • "bill_to_vendor_by_default": true,
  • "billing_address": {
    },
  • "billing_email": "string",
  • "carrier_direct_integration_profile": {
    },
  • "carrier_owner": {
    },
  • "carrier_reference_codes": [
    ],
  • "carrier_status": "ACTIVE",
  • "carrier_status_last_updated": "2019-08-24T14:15:22Z",
  • "carrier_status_updated_by": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "drivers": [
    ],
  • "exclude_from_automated_carrier_status": true,
  • "external_payment_processor_id": "fddb0bd7-ae56-4fa7-a20a-1e7cc98d7ab4",
  • "external_payment_processor_sync_status": "CURRENT",
  • "fmcsa_census_data": {
    },
  • "fmcsa_vendor": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "identifying_codes": [
    ],
  • "insurance_records": [
    ],
  • "is_carrier_insurance_compliance_enabled": true,
  • "is_editable": true,
  • "mailing_address": {
    },
  • "name": "string",
  • "notes": "string",
  • "payment_terms": [
    ],
  • "point_of_contacts": [
    ],
  • "primary_email": "string",
  • "primary_phone_number": "string",
  • "shipwell_vendor": {
    },
  • "tags": [
    ],
  • "terms": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vendor_factoring_company": {
    },
  • "allow_dispatching_despite_exclusion_rules": true,
  • "allow_drivers_sms_shipment_messages": true,
  • "allow_pre_pro_assignment": true,
  • "allow_rating_despite_exclusion_rules": true,
  • "highway_carrier_profiles": [
    ],
  • "pro_number_generation_config": {
    },
  • "rmis_carrier_profiles": [
    ],
  • "saferwatch_carrier_profiles": [
    ]
}
Copyright © Shipwell 2025. All right reserved.