Get the list of relationships with carriers

SecurityAuthToken

Request

query Parameters

page	integer indicates what page of a list of query results you want to view
page-size	integer indicates the how many items to return per page in a list request
ordering	string Determines which column to sort by. Prepend with '-' to sort desc.
q	string search query
id	Array of strings <uuid> Return objects whose ID is one of those provided
carrier_owner_id	string <uuid> Return vendor relationships where carrier_owner has this User ID
carrier_owner_email__contains	string Return vendor relationships where carrier_owner email address contains the value provided
carrier_owner_name__contains	string Return vendor relationships where carrier_owner name contains the value provided
carrier_status	string Return vendor relationships where carrier_status equals the value provided Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
billing_address__contains	string Return objects where the company billing address contains this string
company__contains	string Return objects where the company name contains this string
mailing_address__contains	string Return objects where the company mailing address contains this string
primary_email__contains	string Return objects where the company primary email contains this string
primary_phone_number__contains	string Return objects where the company primary phone number contains this string
mc_number	string search by this (exact) mc number
mc_number__contains	string Return companies where the mc number contains this string
point_of_contacts__contains	string Return objects where a point of contact contains this string in their name or email
tags	Array of strings Return objects with these (exact) tags
tags__contains	string Return objects where one of the tags contains this string
usdot	string search by this (exact) usdot number
usdot__contains	string Return companies where the usdot number contains this string
vendor_id	string Return shipments with this exact value as the vendor Carrier id
load_board_enabled	boolean Return vendor relationships that have at least one load board enabled point of contact
has_direct_integration	boolean Return vendor relationships where Shipwell has a direct integration with the vendor
drivers__contains	string Return objects where a driver contains this string in their full_name or phone_number

Responses

200

Successfully returned a list of carrier relationships

Response Schema: application/json

page_size	integer
	Array of objects (SlimCarrierRelationship)
total_count	integer
total_pages	integer

default

Default error response

get/carrier-relationships/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"page_size": 0,
"results": [{"bill_to_vendor_by_default": true,
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"billing_email": "string",
"carrier_direct_integration_profile": {"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"provider_code": "string"
},
"carrier_owner": {"avatar": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"completed_onboarding": true,
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"default_shipment_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"is_quoting_limited_user": true,
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"password": "string",
"permissions": ["string"
],
"phone_number": "string",
"subscribed_to_loadboard": true,
"timezone": "string",
"units": "IMPERIAL",
"updated_at": "2019-08-24T14:15:22Z",
"verified_email": true
},
"carrier_reference_codes": [{"is_default": true,
"value": "string"
}
],
"carrier_status": "ACTIVE",
"carrier_status_last_updated": "2019-08-24T14:15:22Z",
"carrier_status_updated_by": {"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_name": "string",
"phone_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"drivers": [{"full_name": "string",
"phone_number": "string"
}
],
"exclude_from_automated_carrier_status": true,
"external_payment_processor_id": "fddb0bd7-ae56-4fa7-a20a-1e7cc98d7ab4",
"external_payment_processor_sync_status": "CURRENT",
"fmcsa_census_data": {"active": true,
"cdl_drivers": 0,
"hazmat_indicator": true,
"identification_codes": [{"id": "string",
"name": "string"
}
],
"operating_authority": [{"broker_status": "string",
"common_status": "string",
"contract_status": "string",
"id_code_type": "string",
"id_code_value": "string"
}
],
"revoked": true,
"safety_rating": "string",
"safety_rating_date": "string",
"total_buses": 0,
"total_drivers": 0,
"total_power_units": 0,
"total_trucks": 0,
"usdot": "string"
},
"fmcsa_vendor": {"billing_emails": ["string"
],
"brokerage": {"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_3pl": true,
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary_email": "string",
"primary_phone_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"carrier": {"accounts_receivable_email": "string",
"approved_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"dba_name": "string",
"display_name": "string",
"display_primary_email": "string",
"display_primary_phone_number": "string",
"eld_providers": [{"connection_status": "Active",
"disconnection_reason": {"property1": null,
"property2": null
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_data_report": "2019-08-24T14:15:22Z",
"name": "string",
"tracking_status": "Active"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"pickup_request_email": "string",
"primary_email": "string",
"primary_phone_number": "string",
"scac_number": "string",
"service_center_lookup_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usdot_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": {"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary_email": "string",
"primary_phone_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"updated_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"custom_data": {"property1": null,
"property2": null
},
"feature_flags": {"alerts_dashboard_enabled": true,
"analytics_enabled": true,
"automatic_carrier_policy_enabled": true,
"bid_manager_enabled": true,
"can_initiate_mobile_ping_tracking": true,
"can_override_bill_to_for_automated_ltl": true,
"ch_robinson_enabled": true,
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"contracts_enabled": true,
"edi_invoicing_enabled": true,
"fedex_enabled": true,
"freightwaves_driver_texts_enabled": true,
"genesis_ltl_enabled": true,
"historical_pricing_enabled": true,
"integrations_enabled": true,
"invoicing_enabled": true,
"load_board_enabled": true,
"mfa_enabled": true,
"netsuite_enabled": true,
"new_dashboard_enabled": true,
"order_consolidation_workflows_enabled": true,
"policies_enabled": true,
"purchase_orders_enabled": true,
"rate_tables_enabled": true,
"send_shipwell_network_enabled": true,
"show_load_board": true,
"stop_status_enabled": true,
"supplier_invites_enabled": true,
"triumph_pay_enabled": true,
"ups_enabled": true,
"uses_3pl_quoting_flow": true,
"usps_enabled": true
},
"identifying_codes": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"insurance_expires_at": "2019-08-24T14:15:22Z",
"insurance_policy_number": "string",
"insurance_provider_name": "string",
"insurance_provider_phone": "string",
"insurance_validated_at": "2019-08-24T14:15:22Z",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"maximum_driving_elevation_ft": 0,
"mileage_config_last_updated": "2019-08-24T14:15:22Z",
"mileage_type": "HERE_MAPS",
"primary_phone_number": "string",
"subdomain": "string",
"terms": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identifying_codes": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"insurance_records": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"insurance_expires_at": "2019-08-24T14:15:22Z",
"insurance_limit": "string",
"insurance_policy_number": "string",
"insurance_policy_type": "auto",
"insurance_provider_name": "string",
"insurance_provider_phone": "string",
"insurance_validated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"is_carrier_insurance_compliance_enabled": true,
"is_editable": true,
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"notes": "string",
"payment_terms": [{"account_number": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_default_term": false,
"payment_company_type": "PRIMARY",
"payment_term_description": "string",
"payment_term_trigger": "INVOICE_DATE",
"payment_terms_days": 30,
"payment_type": "CHECK",
"remit_to_information": {"company_name": "string",
"country": "st",
"line_1": "string",
"line_2": "string",
"locality": "string",
"postal_code": "string",
"region": "str",
"urbanization": "string"
},
"routing_number": "string"
}
],
"point_of_contacts": [{"email": "string",
"first_name": "string",
"job_title": "ADMIN",
"last_name": "string",
"phone_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"access_all_customer_shipments": true,
"load_board_enabled": true,
"load_board_invite_last_sent_at": "2019-08-24T14:15:22Z",
"preferences": {"cancellation": true,
"delayed": true,
"delivered": true,
"eta_changed": true,
"picked_up": true,
"receive_bol_on_shipment_booked": true,
"shipment_booked": true,
"trailer_assigned": true
},
"user": "76f62a58-5404-486d-9afc-07bded328704",
"should_send_email": true
}
],
"primary_email": "string",
"primary_phone_number": "string",
"shipwell_vendor": {"billing_emails": ["string"
],
"brokerage": {"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_3pl": true,
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary_email": "string",
"primary_phone_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"carrier": {"accounts_receivable_email": "string",
"approved_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"dba_name": "string",
"display_name": "string",
"display_primary_email": "string",
"display_primary_phone_number": "string",
"eld_providers": [{"connection_status": "Active",
"disconnection_reason": {"property1": null,
"property2": null
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_data_report": "2019-08-24T14:15:22Z",
"name": "string",
"tracking_status": "Active"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"pickup_request_email": "string",
"primary_email": "string",
"primary_phone_number": "string",
"scac_number": "string",
"service_center_lookup_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
"usdot_number": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": {"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary_email": "string",
"primary_phone_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"updated_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"custom_data": {"property1": null,
"property2": null
},
"feature_flags": {"alerts_dashboard_enabled": true,
"analytics_enabled": true,
"automatic_carrier_policy_enabled": true,
"bid_manager_enabled": true,
"can_initiate_mobile_ping_tracking": true,
"can_override_bill_to_for_automated_ltl": true,
"ch_robinson_enabled": true,
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"contracts_enabled": true,
"edi_invoicing_enabled": true,
"fedex_enabled": true,
"freightwaves_driver_texts_enabled": true,
"genesis_ltl_enabled": true,
"historical_pricing_enabled": true,
"integrations_enabled": true,
"invoicing_enabled": true,
"load_board_enabled": true,
"mfa_enabled": true,
"netsuite_enabled": true,
"new_dashboard_enabled": true,
"order_consolidation_workflows_enabled": true,
"policies_enabled": true,
"purchase_orders_enabled": true,
"rate_tables_enabled": true,
"send_shipwell_network_enabled": true,
"show_load_board": true,
"stop_status_enabled": true,
"supplier_invites_enabled": true,
"triumph_pay_enabled": true,
"ups_enabled": true,
"uses_3pl_quoting_flow": true,
"usps_enabled": true
},
"identifying_codes": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"insurance_expires_at": "2019-08-24T14:15:22Z",
"insurance_policy_number": "string",
"insurance_provider_name": "string",
"insurance_provider_phone": "string",
"insurance_validated_at": "2019-08-24T14:15:22Z",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"maximum_driving_elevation_ft": 0,
"mileage_config_last_updated": "2019-08-24T14:15:22Z",
"mileage_type": "HERE_MAPS",
"primary_phone_number": "string",
"subdomain": "string",
"terms": "string"
},
"tags": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"terms": "string",
"updated_at": "2019-08-24T14:15:22Z",
"vendor_factoring_company": {"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"company_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"error_message": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"triumph_pay_key": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"highway_carrier_statuses": [{"dot_number": "string",
"status": "incomplete"
}
],
"rmis_carrier_statuses": [{"mc_number": "string",
"status": "CERTIFIED"
}
],
"saferwatch_carrier_statuses": [{"mc_number": "string",
"status": "string"
}
]
}
],
"total_count": 0,
"total_pages": 0
}