Carriers

Manage the outside carriers you work with, their contacts and finance profiles, and the truck types they run.

Paths are relative to https://api.rushhourapp.com/api/v1. See the API reference overview for how to read each entry.

Carriers

Method	Path	Summary
GET	/OutsourceCompanies	Get all carriers.
POST	/OutsourceCompanies	Add carrier.
DELETE	/OutsourceCompanies	Delete carriers.
GET	/OutsourceCompanies/{id}	Get carrier.
PUT	/OutsourceCompanies/{id}	Update carrier.
GET	/OutsourceCompanies/{id}/Contacts	Get carrier contact details.
GET	/OutsourceCompanies/{id}/DriverList	Get carrier drivers.
POST	/OutsourceCompanies/ValidateOutsourceCompany	Validate carrier.

GET /OutsourceCompanies

Get all carriers.

Required access: the View Outsources permission.

Also accepts the shared list parameters.

Response: envelope; data is OutsourceCompanyListDtoPagedList.

POST /OutsourceCompanies

Add carrier.

Required access: the Add/Edit outsource permission.

Request body: OutsourceCompanyCreateDto (JSON).

Response: envelope; data is OutsourceCompanyDto.

DELETE /OutsourceCompanies

Delete carriers.

Required access: the Delete Outsource permission.

Parameters

Name	In	Type	Required	Description
ids	query	array of integer (int32)	No

Response: envelope; data has no documented shape.

GET /OutsourceCompanies/{id}

Get carrier.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is OutsourceCompanyDto.

PUT /OutsourceCompanies/{id}

Update carrier.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Request body: OutsourceCompanyUpdateDto (JSON).

Response: envelope; data is OutsourceCompanyDto.

GET /OutsourceCompanies/{id}/Contacts

Get carrier contact details.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is OutsourceCompanyContactDetailsResponse.

GET /OutsourceCompanies/{id}/DriverList

Get carrier drivers.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is array of Driver.

POST /OutsourceCompanies/ValidateOutsourceCompany

Validate carrier.

Request body: OutsourceCompanyCreateDto (JSON).

Response: envelope; data is ValidateOutsourceCompanyDto.

Carrier contacts

Method	Path	Summary
POST	/OutsourceCompanyContacts	Create carrier contact.
PUT	/OutsourceCompanyContacts/{id}	Update carrier contact.
DELETE	/OutsourceCompanyContacts/{id}	Delete carrier contact.
PUT	/OutsourceCompanyContacts/{id}/SetPrimary	Set primary contact.
GET	/OutsourceCompanyContacts/{id}/Usage	Get carrier contact usage.
POST	/OutsourceCompanyContacts/Normalize	Normalize contacts.
GET	/OutsourceCompanyContacts/NormalizePreview	Get normalize preview.

POST /OutsourceCompanyContacts

Create carrier contact.

Required access: the Add/Edit outsource permission.

Request body: CustomerContact (JSON).

Response: envelope; data is CustomerContact.

PUT /OutsourceCompanyContacts/{id}

Update carrier contact.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Request body: CustomerContact (JSON).

Response: envelope; data is CustomerContact.

DELETE /OutsourceCompanyContacts/{id}

Delete carrier contact.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes
reassignToPrimary	query	boolean	No	Default: false.

Response: envelope; data is DeleteContactResultDto.

PUT /OutsourceCompanyContacts/{id}/SetPrimary

Set primary contact.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is CustomerContact.

GET /OutsourceCompanyContacts/{id}/Usage

Get carrier contact usage.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is ContactUsageDto.

POST /OutsourceCompanyContacts/Normalize

Normalize contacts.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
outsourceCompanyId	query	integer (int32)	No

Response: envelope; data is NormalizeContactsResultDto.

GET /OutsourceCompanyContacts/NormalizePreview

Get normalize preview.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
outsourceCompanyId	query	integer (int32)	No

Response: envelope; data is NormalizeContactsPreviewDto.

Carrier finance profiles

Method	Path	Summary
POST	/OutsourceCompanyFinances	Add carrier finance.
GET	/OutsourceCompanyFinances/{id}	Get carrier finance.
PUT	/OutsourceCompanyFinances/{id}	Update carrier finance.
DELETE	/OutsourceCompanyFinances/{id}	Delete carrier finances.
GET	/OutsourceCompanyFinances/{id}/FinanceList	Get carrier finances.

POST /OutsourceCompanyFinances

Add carrier finance.

Required access: the Add/Edit outsource permission.

Request body: OutsourceCompanyFinanceCreateDto (JSON).

Response: envelope; data is OutsourceCompanyFinanceDto.

GET /OutsourceCompanyFinances/{id}

Get carrier finance.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes
outsourceCompanyFinanceId	query	integer (int32)	No

Response: envelope; data is OutsourceCompanyFinanceDto.

PUT /OutsourceCompanyFinances/{id}

Update carrier finance.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Request body: OutsourceCompanyFinanceDto (JSON).

Response: envelope; data is OutsourceCompanyFinanceDto.

DELETE /OutsourceCompanyFinances/{id}

Delete carrier finances.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes
ids	query	array of integer (int32)	No

Response: envelope; data has no documented shape.

GET /OutsourceCompanyFinances/{id}/FinanceList

Get carrier finances.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is array of OutsourceCompanyFinanceDto.

Carrier truck types

Method	Path	Summary
POST	/OutsourceCompanyTypeOfTrucks	Add carrier type of truck.
GET	/OutsourceCompanyTypeOfTrucks/{id}	Get carrier type of truck.
PUT	/OutsourceCompanyTypeOfTrucks/{id}	Update carrier type of truck.
DELETE	/OutsourceCompanyTypeOfTrucks/{id}	Delete carrier type of trucks.
GET	/OutsourceCompanyTypeOfTrucks/{id}/TypeOfTruckList	Get carrier type of trucks.

POST /OutsourceCompanyTypeOfTrucks

Add carrier type of truck.

Required access: the Add/Edit outsource permission.

Request body: OutsourceCompanyTypeOfTruckCreateDto (JSON).

Response: envelope; data is OutsourceCompanyTypeOfTruckDto.

GET /OutsourceCompanyTypeOfTrucks/{id}

Get carrier type of truck.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes
outsourceCompanyTypeOfTruckId	query	integer (int32)	No

Response: envelope; data is OutsourceCompanyTypeOfTruckDto.

PUT /OutsourceCompanyTypeOfTrucks/{id}

Update carrier type of truck.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Request body: OutsourceCompanyTypeOfTruckDto (JSON).

Response: envelope; data is OutsourceCompanyTypeOfTruckDto.

DELETE /OutsourceCompanyTypeOfTrucks/{id}

Delete carrier type of trucks.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes
ids	query	array of integer (int32)	No

Response: envelope; data has no documented shape.

GET /OutsourceCompanyTypeOfTrucks/{id}/TypeOfTruckList

Get carrier type of trucks.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data is array of OutsourceCompanyTypeOfTruckDto.

Truck types

Method	Path	Summary
GET	/TypeOfTrucks	List truck types.
POST	/TypeOfTrucks	Create a truck type.
GET	/TypeOfTrucks/{id}	Get a truck type.
PUT	/TypeOfTrucks/{id}	Update a truck type.
DELETE	/TypeOfTrucks/{id}	Delete a truck type.

GET /TypeOfTrucks

List truck types.

Required access: the View Outsources permission.

Response: envelope; data is TypeOfTruckDtoPagedList.

POST /TypeOfTrucks

Create a truck type.

Required access: the Add/Edit outsource permission.

Request body: TypeOfTruckCreateDto (JSON).

Response: envelope; data has no documented shape.

GET /TypeOfTrucks/{id}

Get a truck type.

Required access: the View Outsources permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

PUT /TypeOfTrucks/{id}

Update a truck type.

Required access: the Add/Edit outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Request body: TypeOfTruckCreateDto (JSON).

Response: envelope; data has no documented shape.

DELETE /TypeOfTrucks/{id}

Delete a truck type.

Required access: the Delete Outsource permission.

Parameters

Name	In	Type	Required	Description
id	path	integer (int32)	Yes

Response: envelope; data has no documented shape.