Retrieve a CarrierAssignment by its id

SecurityAuthToken
Request
path Parameters

shipmentId required	string <uuid> The id of the shipment
carrierAssignmentId required	string <uuid> The id of a CarrierAssignment
Responses
200
The requested CarrierAssignment
Response Schema: application/json

carrier_reference_code	string or null
created_at	string or null <date-time>
	object (Company)
	Array of objects (ShipmentChargeLineItem) Costs owed to vendor as the customer records them, readable by both customer and vendor but writable only by the customer
id	string or null <uuid>
is_assigned_carrier	boolean
updated_at	string or null <date-time>
required	object (Company)
	Array of objects (ShipmentChargeLineItem) Costs owed to vendor as the vendor records them, readable by both customer and vendor but writable only by the vendor
vendor_point_of_contact	string or null <uuid>
default
Default error response
get/shipments/{shipmentId}/carrier-assignments/{carrierAssignmentId}/
Request samples
curl
Node.js
JavaScript
Python
Java
Response samples
200
default
application/json
{"carrier_reference_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"customer": {"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,
"rmis_enabled": true,
"saferwatch_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"
},
"customer_charge_line_items": [{"amount": 0.1,
"category": "ACC",
"charge_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"unit_amount": 0.1,
"unit_amount_currency": "CAD",
"unit_name": "string",
"unit_quantity": 1,
"updated_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"prepaid_amount": 0.1,
"vendor_assignment": "a97f4721-ce89-4a5b-a56a-dde2b6583de2"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_assigned_carrier": true,
"updated_at": "2019-08-24T14:15:22Z",
"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,
"rmis_enabled": true,
"saferwatch_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"
},
"vendor_charge_line_items": [{"amount": 0.1,
"category": "ACC",
"charge_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"unit_amount": 0.1,
"unit_amount_currency": "CAD",
"unit_name": "string",
"unit_quantity": 1,
"updated_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"prepaid_amount": 0.1,
"vendor_assignment": "a97f4721-ce89-4a5b-a56a-dde2b6583de2"
}
],
"vendor_point_of_contact": "f21065b9-a4a6-4edb-bb46-20a9d9f7a8f0"
}