Get the current equipment config associated with this shipment

SecurityAuthToken

Request

path Parameters

shipmentId

required

string <uuid>

The id of the shipment

Responses

200

Successfully returned an equipment Config

Response Schema: application/json

	object (Carrier)
created_at	string or null <date-time>
	object (Driver)
driver_pin	integer or null <int32>
id	string or null <uuid>
	object (PowerUnit)
shares_tracking_resource	boolean or null Whether the attached power unit or driver is already on another non-terminal shipment. Available on both /shipments/{shipmentId}/equipment-config/ and /shipments/{shipmentId}/carrier-config/; when true, the frontend opens the scheduling modal and fetches GET /shipments/{shipmentId}/tracking-schedule/.
	object (Trailer)
updated_at	string or null <date-time>

default

Default error response

get/shipments/{shipmentId}/equipment-config/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"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",
"driver": {"app_last_opened_at": "2019-08-24T14:15:22Z",
"cdl_number": "string",
"cdl_state": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"hos": {"break": 0,
"cycle": 0,
"drive": 0,
"shift": 0
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_name": "string",
"phone_number": "string",
"pin": 0,
"platform": "iOS",
"provider": "string",
"status": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"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
}
},
"driver_pin": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"power_unit": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"distance_traveled_miles": 0.1,
"from_eld_provider": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_data_report": "2019-08-24T14:15:22Z",
"license_plate_number": "string",
"license_plate_state_province": "string",
"make": "string",
"model": "string",
"name": "string",
"provider": "string",
"status": "Active",
"updated_at": "2019-08-24T14:15:22Z",
"vin": "string"
},
"shares_tracking_resource": true,
"trailer": {"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"distance_traveled_miles": 0.1,
"equipment_type": {"id": 0,
"machine_readable": "string",
"name": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"license_plate_number": "string",
"license_plate_state_province": "string",
"max_haul_volume_ft3": 0,
"max_haul_weight_lbs": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"updated_at": "2019-08-24T14:15:22Z"
}