Highway provides Carrier onboarding and monitoring with Highway Carrier Onboarding.
The Revenova integration with Highway provides the following information.
Get completed Carrier Application/Highway packets and creates the Carriers in the TMS.
Gets the latest set of Carrier information changes and updates the Carriers in the TMS.
Synchronizes the list of monitored Carriers between the TMS and Highway.
The list of 'monitored Carriers' are Carriers with the Monitor Carrier Checked on the Transportation Profile.
Orgs using a custom integration with Highway must open a Case with Revenova Support before using the new integration.
Setup
Navigate to the Highway website and log in to the broker portal. Add and configure the desired risk questions to add to the Carrier application. Any Carriers not currently in the Highway system are onboarded with these questions.
Warning:
If using Highway, do NOT enable MyCarrierPackets, SaferWatch, or RMIS. Disable MyCarrierPackets, RMIS, and SaferWatch in TMS Admin → Credentials → Global Services.
Remote Site Settings
Check the Remote Site Settings when upgrading from a previous release TMS release. Verify they match the Service and Test Service URLs listed below.
Click the Setup gear icon in the top right corner.
From the drop-down, click Setup.
In the Quick Find Toolbar type Remote Site Settings and click the link.
From the list of remote sites confirm the Highway URLs are created.
Update or create the Remote Site URLs to match the URLs below.
Service URL: https://highway.com/core/connect/external_api/v1/
Test Service URL: https://staging.highway.com/core/connect/external_api/v1/
Proxy URL: https://dev.revenova.com:8085
Named Credential
Verify that the Highway Named Credential is available in the org. Complete the following steps to finish configuring the connected app.
From Setup → Named Credentials.
Find the Highway Named Credential.
Confirm the URL for the Highway Named Credential URL is https://dev.revenova.com:8085.
If the Highway Named Credential does not exist, complete the following steps to create it.
Create an External Credential by selecting the External Credentials tab and choose the New button.
Enter and select the following field values.
Label: Highway
Name: Highway
Authentication Protocol: Custom
Click Save.
Return to the Named Credentials tab.
Click the New button to create a new Named Credential.
Enter the following field values.
Label: Highway
Name: Highway
URL: https://dev.revenova.com:8085
Enabled for Callouts: Enabled
External Credential: Highway
Allow Formulas in HTTP Header: Checked
Click Save.
Credentials Card
Enable the Highway integration by completing the following steps.
Navigate to TMS Admin.
Select Credentials.
Select the Global Services tab.
Find Highway in the list and select the card.
Check the Enabled box.
Enter the following value into the Proxy URL field.
https://dev.revenova.com:8085
Click Save.
TMS Admin
Global Settings
Default Carrier Mode: Use this mode when onboarding Carriers from Highway if the packet from Highway does not include a Mode.
Allow Carrier Address Updates: Check this box to allow Carrier addresses to update from Highway.
Carrier Management
Carrier Monitor Last Run: View the most recent date and time the Carrier Monitor job ran.
Carrier Monitor Run Frequency (Mins): Controls how frequently the call is made to retrieve Carrier alerts from Highway. The recommended setting is 15 minutes.
Modes
The Mode field is populated on the 6 packaged modes received from Highway:
Air Freight
Dryage
Intermodal
LTL
Ocean
Truckload
If using custom Modes, navigate to the Modes page under TMS Admin → Modes. For each Mode, enter the text of the corresponding mode received from Highway into the Highway Mode field. See the reference table below for the list of Modes received from Highway. When onboarding new Carriers, Carrier Services are created for each Highway Mode.
Setup API user
Verify that an API User exists in the org.
Multiple integrations may require an API User. If an API User already exists in an org., add the Highway API User permission set to the existing API User and skip the steps to create a new API user.
Navigate to Setup and then search for and click the Users link.
Click the New User button and enter the following fields.
First Name: API
Last Name: User (The First and Last Name fields may be any value, but should reference API User for clarity.)
Email: Set as the system admin’s email.
Username: Change if necessary.
User License: Salesforce Integration
Profile: Minimum Access - API Only Integrations
Click Save.
Add the Permission Set Highway API User to the user.
The API User requires a TMS license. If creating an API User for the first time, assign a TMS license to the API User.
.png)
See Salesforce documentation for additional information on creating API Users.
Connected App
The integration with Highway requires a Connected App to operate properly.
Verify that the Highway API Connection Connected App is created and available in the org. Complete the following steps to finish configuring the connected app.
From Setup → App Manager find Highway API Connection.
From the drop-down, select Edit.
Check the Enable Client Credentials Flow box.
Click Save.
Return to Setup → App Manager and find the Highway API Connection app.
From the drop-down, select Manage.
Choose the Edit Policies button.
In the Client Credentials Flow section, find the Run As field.
Click the Run As Lookup button.
Select the API User created above.
Click Save.
Create a Connected app by following the steps below. Skip these steps when the Highway API Connection App already exists.
Create the Connected App.
Navigate to Setup and search for External Client Apps and select the Settings link.
From the Connected Apps section, choose On for Allow creation of connected apps.
Click the Enable button on the modal to create Connected Apps.
Click the New Connected App button.
Select Create a Connected App and choose Continue.
Enter the following information into the fields.
Connected App Name: Highway API Connection
API Name: Auto-Generated based on the Connected App Name.
Contact Email: System admin’s email.
Enabled OAuth Setting: Checked.
Callback URL: https://login.salesforce.com/.
Selected OAuth Scopes: Add Full Access (full), Manage user data via APIs (api), and Perform requests at any time (refresh_token, offline_access).
Enable Client Credentials Flow: Checked.
Click Save.
From the list of apps, find the new Highway API Connection app.
Click the Manage button from the drop-down.
Choose the Edit Policies button.
From the Client Credentials Flow section find the Run As field and choose the API User.
Click Save.
Consumer Key and Secret, 18-Character Org Id
Navigate to Setup and then search for and click the App Manager link.
In the Highway API Connection row click the arrow and select to View.
Click Manage Consumer Details and enter the two-factor verification code. Copy the Consumer Key and Consumer Secret for later use.
Copy 18-Character Organization Id
From the Setup drop-down, choose Developer Console.
Select the Query Editor tab.
Enter SELECT Id from Organization into the field.
Click the Execute button.
Copy and Save the 18-Character Organization Id.
When complete, open a Case with Revenova Support and include the following information to complete Highway setup.
Login URL for the Org
18-Character Organization ID
Consumer Key
Consumer Secret
Batch Processes
New Carrier packets and Carrier updates are retrieved by the CarrierMonitorHighwayJob. Run this job to call the Highway API end points described below. The job runs continuously and contains 3 separate passes.
Name | Purpose | ‘Run Now’ Action | ‘Schedule’ Action |
|---|---|---|---|
CarrierMonitorHighwayJob |
| Active – runs job immediately | Inactive - invoked by itself upon completion |
QueuedTransactionJob |
| Active - runs job immediately | Inactive - initiated by itself upon completion |
Pass 1: Calls the New Onboarding Packets end point to create new Carrier records in the TMS.
Pass 2: Calls the Carrier Alerts end point and updates TMS records with any changes.
Pass 2 runs according to the Carrier Monitor Run Frequency (Mins) field.
Carriers must have the Monitor Carrier field Checked to process alerts from Highway.
Pass 3: Calls the Sync Carrier Profiles end point to update any policies or other records.
Pass 3 runs once a week on Sunday evening.
Carrier packets and alerts are processed by the QueuedTransactionJob.
Both the CarrierMonitorHighwayjob and QueuedTransactionjob must be running to process information received from Highway. Run the CarrierMonitorHighwayJob from the list of Batch Processes on the Batch Process Monitor or Performance IQ Lightning Web Component (LWC).
View the CarrierMonitorHighwayJob in the PerformanceIQ LWC.
Bank Account information is included in the packet from Highway. If necessary, set up NACHA payment information when added to the TMS.
Onboard Carrier LWC
Add the Onboard Carrier LWC to the Home page, or another page as necessary.
The Onboard Carrier LWC searches the available Carriers in the Highway system to add them to the TMS. Any Carriers not currently monitored by Highway may be invited to complete a Carrier application and then added to the TMS. Add the Onboard Carrier LWC to the appropriate page layout to begin using the Highway integration.
Select the Identifier Type from the picklist and enter the corresponding Value. Search by any of the following identifiers.
US DOT Number
MC Number
SCAC
Press Enter to search for Carriers in the Highway database.
TMS Operation | Highway Endpoint | Request Type | Response |
|---|---|---|---|
Enter on the Onboard Carrier LWC | Query | GET | 200: Success 400: Request Error |
If the Carrier is found in the Highway system, an onboarding invitation is sent from Highway to the Carrier with the email provided in the LWC. The email address is usually the user making the request in the LWC.
Press the Clear button to remove the values and search again.
If a Carrier is not found in the Highway system, click the Send Invite via Highway button to generate an invitation. When the Carrier has completed the onboarding questions, the packet is added to the TMS the next time the job runs.
TMS Operation | Highway Endpoint | Request Type | Response |
|---|---|---|---|
Send Invite via Highway on the Onboard Carrier LWC | Create | POST | 200: Success 400: Request Error |
If a Carrier is already present in the TMS, a hyperlink to the Transportation Profile is provided.
Each Carrier must be added from the LWC for the CarrierMonitorHighwayJob to request the Carrier information.
API Calls
The three API endpoints called by the CarrierMonitorHighwayJob are described below.
For payload examples and additional integration information, visit Highway.
Get New Onboarding Packets
Onboarding packets contain Carrier information including bank account, insurance policies, and any associated W-9 file.
TMS Operation | Highway Endpoint | Request Type | Response |
|---|---|---|---|
Pass 1: Onboard new Carriers | Get New Onboarding Packets | GET | 200: Success 400: Request Error |
When creating a Factoring Account, the currency is set based on the billing address country. If no billing address is available, the shipping address country determines the country.
When a non-Factoring Carrier Account is created, the currency is set based on the first address country received. The currency can be set by either the billing or shipping address.
The currency is added to the Account, Carrier Service, and Transportation Profile records. Each Insurance Policy from Highway contains a currency and is added to each record.
Any available insurance certificate files are included in the Carrier packet and saved to the files section of the Insurance Policy object.
When a W9 file is associated with a Carrier, the W9 file is downloaded and stored on the Transportation Profile.
Payment Terms
Payment Term records are created when the charge_basis field in the Carrier packet is percentage. If the charge_basis is not percentage, no Payment Term record is created. The TMS checks if Payment Term record exists. If no matching record exists, a new one is created. The Payment Discount % and Payment Days Due fields are compared to match the Payment Term records.
Payment Term fields are populated with the fields in the Carrier packet. When the Payment Term Type is factoring, a Factoring Company Account is created in the TMS and is added to the Carrier Payment Terms field on the Carrier Transportation Profile.
When the Payment Term Type is a value other than factoring, the new Payment Term record is added to the Carrier Payment Terms field.
In cases where a Factoring Account is not present, the Currency is determined by the Billing/Shipping Code address currency code. The Currency is added to the Account, Carrier Service, and Transportation Profile records. Each Insurance Policy contains a currency value.
The Carrier Remit To Sync field on TMS Admin → Configuration may be Checked or not. Highway does not send updates to sync the Carrier Remit To fields.
The payment method type field from Highway determines the values added to Account or Transportation Profiles as described below. Bank Account records are created when payment method type is ach, check, wire, or cad_eft.
When the payment method is ach, the Account Default Payment Method field is set to ACH (NACHA File).
When the payment method is check, the Account Default Payment Method field is set to Check.
When the payment method is triumph_pay, the Transportation Profile Payment Processor field is set to TriumphPay.
When the payment method is comcheck, the Transportation Profile EPayment Authorized field is set to Comdata Comchek.
When the payment method is efs, the Transportation Profile EPayment Authorized field is set to EFS Money Code.
Bank Accounts
Carrier packets containing bank information create Bank Account records for the Carrier. Additional setup is necessary to send ACH payments to Carriers.
The Account Number and Confirm Account Number fields received from Highway only contain the last 4 digits. The remaining digits must be entered manually to send ACH payments successfully to Carriers.
When Carrier packets from Highway finish processing and are available in the TMS, complete the following steps.
Navigate to the App Launcher and search for Bank Accounts to view the related list.
Each Bank Account record must have the following field values.
The ACH Active field must be Checked.
The Account Type picklist must have a value (either Checking or Savings).
The ACH Payee Name field must have a value.
To send a notification of payment, the ACH Remittance Document picklist must have a selection (either ACHRemittanceDetail or ACHRemittanceSummary).
Carrier Services
Carrier Services are created for new Carriers with the following attributes.
The Quote, Status, and Tender Methods are all set to Email by the TMS.
The Minimum Weight is set to 100.
The Maximum Weight is set to 45,000.
The Weight Units field is set to lbs.
Carrier Services are set to Enabled.
The Carrier Service Settlement Contact defaults to the Account Contact with the Transportation Role Quoting value. The Contact type returned from Highway is “Dispatch.”
Ocean FCL and Ocean LCL Carrier Services are created for a Carrier when the ocean mode is received from Highway.
Carrier Review Status
All classification fields provided by Highway are stored as Pass/Fail on the Transportation Profile Risk Assessment fields.
If all Classifications pass, the assessment is set as Acceptable.
If at least one Classification passes, the assessment is set as Moderate.
If no Classifications pass, but one is Incomplete, the assessment is set as Pending.
If no Classifications pass, the assessment is set as Unacceptable.
The Carrier Review Status field is set by a flow based on the following criteria.
If the Highway Connection Status is Do Not Use or Needs to Onboard, the Carrier Review Status is set to Rejected.
If the Highway Connection Status has a value other than Do Not Use or Needs to Onboard, the Highway Overall Result determines the status.
If the Highway Overall Result is Pass or Partial Pass, the Carrier Review Status is set to Approved.
If the Highway Overall Result is Incomplete, the Carrier Review Status is set to Incomplete Application.
If the Highway Overall Result is Fail, the Carrier Review Status is set to Rejected.
TMS Field Updates
Object | Field | Type | Highway Field |
|---|---|---|---|
Account | Account Name | Name | Received from Highway |
Account | Billing Address | Address | Received from Highway |
Account | Currency | Currency | Set by the TMS. |
Account | DBA Name | Text(80) | Received from Highway |
Account | Default Payment Method | Picklist | Received from Highway |
Account | Fax | Fax | Received from Highway |
Account | Phone | Phone | Received from Highway |
Account | Shipping Address | Address | Received from Highway |
Bank Account | Bank Name | Text(40) | *Received from Highway |
Bank Account | Account Number | Text (Encrypted) (17) | *Received from Highway |
Bank Account | Confirm Account Number | Text (Encrypted) (17) | *Received from Highway |
Bank Account | Routing Number | Text(9) | *Received from Highway |
Carrier Equipment Type | Equipment Type | Master-Detail(Equipment Type) | Received from Highway |
Carrier Equipment Type | Name | Auto Number | Received from Highway |
Carrier Equipment Type | Number | Number(18, 0) | Received from Highway |
Carrier Service | Batch Status Emails | Checkbox | Set to Checked by the TMS. |
Carrier Service | Currency | Currency | Set by the TMS. |
Carrier Service | Enabled | Checkbox | Set to Checked by the TMS. |
Carrier Service | Maximum Weight | Number(18, 0) | Set to 45000 lbs by the TMS. |
Carrier Service | Minimum Weight | Number(18, 0) | Set to 100 by the TMS. |
Carrier Service | Mode | Master-Detail(Mode) | Received from Highway |
Carrier Service | Name | Text(80) | “Account Name + Mode Name” |
Carrier Service | Quote Contact | Lookup(Contact) | Dispatch Contact from the Contact record. |
Carrier Service | Quote Method | Picklist | Set to Email by the TMS. |
Carrier Service | Status Contact | Lookup(Contact) | Status Contact from the Contact record. |
Carrier Service | Status Method | Picklist | Set to Email by the TMS. |
Carrier Service | Tender Contact | Lookup(Contact) | Tender Contact from the Contact record. |
Carrier Service | Tender Method | Picklist | Set to Email by the TMS. |
Carrier Service | Weight Units | Picklist | Set to lbs by the TMS. |
Contact | Received from Highway | ||
Contact | Name | Name | Received from Highway |
Contact | Phone | Phone | Received from Highway |
Contact | Transportation Role | Picklist (Multi-Select) | Received from Highway |
Insurance Policy | Address | Text Area(255) | Received from Highway |
Insurance Policy | Cancel Date | Date | Received from Highway |
Insurance Policy | City | Text(100) | Received from Highway |
Insurance Policy | Coverage Amount | Currency(18, 0) | Received from Highway |
Insurance Policy | Currency | Currency | Received from Highway |
Insurance Policy | Effective Date | Date | Received from Highway |
Insurance Policy | Expiry Date | Date | Received from Highway |
Insurance Policy | Insurance Company | Text(255) | Received from Highway |
Insurance Policy | Phone | Phone | Received from Highway |
Insurance Policy | Policy Number | Text(80) | Received from Highway |
Insurance Policy | Postal Code | Text(20) | Received from Highway |
Insurance Policy | Source | Picklist | Set as Highway by the TMS. |
Insurance Policy | State/Province | Text(30) | Received from Highway |
Insurance Policy | Type | Picklist | Received from Highway |
Payment Terms | Name | Text(80) | Received from Highway |
Payment Terms | Payment Days Due | Number(3, 0) | Received from Highway |
Payment Terms | Payment Discount % | Percent(3, 2) | Received from Highway |
Payment Terms | **Type | Picklist | Set to Vendor by the TMS. |
Transportation Profile | Agreement Date | Date | Received from Highway |
Transportation Profile | ***Agreement Signed By | Lookup(Contact) | Received from Highway |
Transportation Profile | Agreement Status | Picklist (“Verified”) | Received from Highway |
Transportation Profile | Authority Granted Date | Date | Received from Highway |
Transportation Profile | Authority Risk | Picklist | Received from Highway |
Transportation Profile | Broker Authority Pending | Picklist | Received from Highway |
Transportation Profile | Broker Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Broker Authority Status | Picklist | Received from Highway |
Transportation Profile | Cargo Carried | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Carrier Operation | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Carrier Review Comments | Text Area(255) | Received from Highway |
Transportation Profile | Carrier Review Status | Picklist | Calculated by the TMS. |
Transportation Profile | Common Authority Pending | Picklist | Received from Highway |
Transportation Profile | Common Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Common Authority Status | Picklist | Received from Highway |
Transportation Profile | Company Risk | Picklist | Received from Highway |
Transportation Profile | Company Type | Picklist | Received from Highway |
Transportation Profile | Connection Status | Picklist | Received from Highway |
Transportation Profile | Contract Authority Pending | Picklist | Received from Highway |
Transportation Profile | Contract Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Contract Authority Status | Picklist | Received from Highway |
Transportation Profile | Currency | Currency | Set by the TMS. |
Transportation Profile | EPayment Authorized | Picklist | Received from Highway |
Transportation Profile | Federal Tax ID | Text (Encrypted)(11) | Received from Highway |
Transportation Profile | Fleet Size | Number(18, 0) | Received from Highway |
Transportation Profile | Highway ID | Text(40) (External ID) | Received from Highway |
Transportation Profile | Insurance Risk | Picklist | Received from Highway |
Transportation Profile | Last Carrier Review Date | Date/Time | Received from Highway |
Transportation Profile | MC/MX/FF Number | Text(20) | Received from Highway |
Transportation Profile | Name | Text(80) | Received from Highway |
Transportation Profile | Operation Risk | Picklist | Received from Highway |
Transportation Profile | Other Carrier Capabilities | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Out of Service | Picklist | Received from Highway |
Transportation Profile | Out of Service Date | Date | Received from Highway |
Transportation Profile | Overall Risk | Picklist | Received from Highway |
Transportation Profile | Safety Rating | Picklist | Received from Highway |
Transportation Profile | Safety Rating Date | Date | Received from Highway |
Transportation Profile | Safety Risk | Picklist | Received from Highway |
Transportation Profile | SCAC | Text(6) | Received from Highway |
Transportation Profile | State DOT Number | Text(20) | Received from Highway |
Transportation Profile | Total Power Units | Number(18, 0) | Received from Highway |
Transportation Profile | Total US Vehicle Inspections | Number(18, 0) | Received from Highway |
Transportation Profile | US DOT Number | Text(10) | Received from Highway |
*Fields marked with an asterisk are required.
**Set to “Vendor” when present in the response from Highway.
***If the Contact does not exist for the Carrier, a Contact is created. The Name is set to the signed_by value and the Email is set to the signed_by_email value.
If no Tender or Status Contacts are received from Highway, the Quote Contact is added to the Carrier Service for tendering and status updates.
Get Carrier Alerts
Carrier Alerts are requested from Highway based on the Carrier Monitor Run Frequency (Mins) field. The recommended setting is 15 minutes.
Any new Insurance Policies are added during the Carrier Alert call. Any new W9 files are also added.
TMS Operation | Highway Endpoint | Request Type | Response |
|---|---|---|---|
Pass 2: Receive Carrier Alerts | Get New Alerts | GET | 200: Success 400: Request Error |
The Account Billing and Shipping Address fields only update if the Allow Address Updates field is Checked on TMS Admin → Configuration.
The Account DBA Name, Phone, and Fax fields only updates if there is no value in the field.
TMS Field Updates
Object | Field | Type | Highway Field |
|---|---|---|---|
Account | Billing Address | Address | Received from Highway |
Account | Fax | Fax | Received from Highway |
Account | Phone | Phone | Received from Highway |
Account | DBA Name | Text(80) | Received from Highway |
Account | Shipping Address | Address | Received from Highway |
Transportation Profile | Authority Granted Date | Date | Received from Highway |
Transportation Profile | Authority Risk | Picklist | Received from Highway |
Transportation Profile | Broker Authority Pending | Picklist | Received from Highway |
Transportation Profile | Broker Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Broker Authority Status | Picklist | Received from Highway |
Transportation Profile | Cargo Carried | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Carrier Operation | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Carrier Review Status | Picklist | Calculated by the TMS. |
Transportation Profile | Common Authority Pending | Picklist | Received from Highway |
Transportation Profile | Common Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Common Authority Status | Picklist | Received from Highway |
Transportation Profile | Company Risk | Picklist | Received from Highway |
Transportation Profile | Company Type | Picklist | Received from Highway |
Transportation Profile | Contract Authority Pending | Picklist | Received from Highway |
Transportation Profile | Contract Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Contract Authority Status | Picklist | Received from Highway |
Transportation Profile | Federal Tax ID | Text (Encrypted)(11) | Received from Highway |
Transportation Profile | Fleet Size | Number(18, 0) | Received from Highway |
Transportation Profile | Insurance Risk | Picklist | Received from Highway |
Transportation Profile | Last Carrier Review Date | Date/Time | Received from Highway |
Transportation Profile | MC/MX/FF number | Text(20) | Received from Highway |
Transportation Profile | Name | Text(80) | Received from Highway |
Transportation Profile | Operation Risk | Picklist | Received from Highway |
Transportation Profile | Other Carrier Capabilities | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Out of Service | Picklist | Received from Highway |
Transportation Profile | Out of Service Date | Date | Received from Highway |
Transportation Profile | Overall Risk | Picklist | Received from Highway |
Transportation Profile | Safety Rating | Picklist | Received from Highway |
Transportation Profile | Safety Rating Date | Date | Received from Highway |
Transportation Profile | Safety Risk | Picklist | Received from Highway |
Transportation Profile | SCAC | Text(6) | Received from Highway |
Transportation Profile | State DOT Number | Text(20) | Received from Highway |
Transportation Profile | Total Power Units | Number(18, 0) | Received from Highway |
Transportation Profile | Total US Vehicle Inspections | Number(18, 0) | Received from Highway |
Transportation Profile | US DOT Number | Text(10) | Received from Highway |
Sync Carrier Profiles
The Sync Carrier Profiles call is made once a week, typically late on Sunday. The Rules assessment, Carrier certifications, and Insurance Policies are retrieved to ensure that all Carrier information is no more than one week old.
Any new Insurance Policies are added during the Carrier Alert call. Any new W9 files are also added.
The Account DBA Name field only updates if there is no value in the field.
TMS Operation | Highway Endpoint | Request Type | Response |
|---|---|---|---|
Pass 3: Sync Carrier Profiles | Sync Carrier Profiles | GET | 200: Success 400: Request Error |
Carriers match based on the Highway ID field. The most recent Carrier Alerts are retrieved to insure the latest compliance and risk ratings are up to date for each Carrier.
TMS Field Updates
Object | Field | Type | Highway Field |
|---|---|---|---|
Account | DBA Name | Text(80) | Received from Highway |
Transportation Profile | Authority Risk | Picklist | Received from Highway |
Transportation Profile | Connection Status | Picklist | Received from Highway |
Transportation Profile | Insurance Risk | Picklist | Received from Highway |
Transportation Profile | Last Carrier Review Date | Date/Time | Received from Highway |
Transportation Profile | MC/MX/FF number | Text(20) | Received from Highway |
Transportation Profile | Name | Text(80) | Received from Highway |
Transportation Profile | Operation Risk | Picklist | Received from Highway |
Transportation Profile | Overall Risk | Picklist | Received from Highway |
Transportation Profile | Safety Risk | Picklist | Received from Highway |
Transportation Profile | US DOT Number | Text(10) | Received from Highway |
Table Guide
Compare Highway with other Carrier monitoring integrations by viewing the Carrier Monitoring field updates table.
The following fields are inserted/updated by the Highway Carrier Monitoring API as follows.
I – Insert
U – Update
(1) => Update if the global setting Allow Carrier Address Updates is Checked OR the value in the TMS field is null.
(2) – Update if the value in the TMS field is null.
(3) – Update if there is a value in the response.
(4) – Update if there is a value in the response AND the value in the TMS field is null.
(5) – Update if the global setting Carrier Remit To Sync is checked AND the response has factor company information.
(6) – Update to Pending if RMIS Certified is not Yes.
(7) – Set to Pending by the TMS.
(8) - Set to Email by the TMS.
(*) - If a W9 file is associated with the Carrier, the file is downloaded and attached to the Transportation File. No field values are updated.
(**) - If a file is associated with an Insurance Policy in the Highway system, the file is downloaded and added to the Files section of the Insurance Policy record.
Object | Field | Highway |
|---|---|---|
Account | Account Name | I |
Account | BillingStreet | I / U (1) |
Account | BillingCity | I / U (1) |
Account | BillingStateCode | I / U (1) |
Account | BillingPostalCode | I / U (1) |
Account | BillingCountryCode | I / U (1) |
Account | Currency | I |
Account | DBA Name | I |
Account | Default Payment Method | I |
Account | Fax | I |
Account | Name | I |
Account | Phone | I |
Account | ShippingStreet | I / U (1) |
Account | ShippingCity | I / U (1) |
Account | ShippingStateCode | I / U (1) |
Account | ShippingPostalCode | I / U (1) |
Account | ShippingCountryCode | I / U (1) |
Bank Account | Account Number | I |
Bank Account | Bank Name | I |
Bank Account | Confirm Account Number | I |
Bank Account | Routing Number | I |
Carrier Equipment Type | Equipment Type | I |
Carrier Equipment Type | Name | I |
Carrier Equipment Type | Number | I |
Carrier Service | Batch Status Emails | I |
Carrier Service | Currency | |
Carrier Service | Enabled | I |
Carrier Service | Maximum Weight | I |
Carrier Service | Minimum Weight | I |
Carrier Service | Mode | I |
Carrier Service | Name | I |
Carrier Service | Quote Contact | I |
Carrier Service | Quote Method | I (8) |
Carrier Service | Status Contact | I |
Carrier Service | Status Method | I |
Carrier Service | Tender Contact | I |
Carrier Service | Tender Method | I (8) |
Carrier Service | Weight Units | I |
Contact | First Name | I |
Contact | Last Name | I |
Contact | I | |
Contact | Fax | |
Contact | Mobile Phone | |
Contact | Phone | I |
Contact | Title | |
Contact | Transportation Role | I |
Insurance Policy | Name | I / U (**) |
Insurance Policy | Currency | I / U |
Insurance Policy | Address | I / U |
Insurance Policy | Agent Company | |
Insurance Policy | Agent Email | |
Insurance Policy | Agent Phone | |
Insurance Policy | Cancel Date | I / U |
Insurance Policy | City | I / U |
Insurance Policy | Coverage Amount | I / U |
Insurance Policy | Effective Date | I / U |
Insurance Policy | Expiry Date | I / U |
Insurance Policy | Fax | |
Insurance Policy | Insurance Company | I / U |
Insurance Policy | Phone | I / U |
Insurance Policy | Policy Number | I / U |
Insurance Policy | Postal Code | I / U |
Insurance Policy | Reefer Breakdown Coverage | |
Insurance Policy | Reefer Breakdown Deductible | |
Insurance Policy | Deductible | |
Insurance Policy | Source | I / U |
Insurance Policy | State/Province | I / U |
Insurance Policy | Type | I / U |
Payment Terms | Name | I |
Payment Terms | Payment Days Due | I |
Payment Terms | Payment Discount % | I |
Payment Terms | Type | I |
Transportation Profile | Agreement Date | I |
Transportation Profile | Agreement Signed By | I |
Transportation Profile | Agreement Status | I |
Transportation Profile | Authority Granted Date | I / U |
Transportation Profile | Authority Points | |
Transportation Profile | Authority Risk | I / U |
Transportation Profile | Broker Authority Pending | I / U |
Transportation Profile | Broker Authority Revocation | I / U |
Transportation Profile | Broker Authority Status | I / U |
Transportation Profile | Canada Province Coverage | |
Transportation Profile | CARB TRU Certificate Expiration Date | |
Transportation Profile | CARB TRU Compliant Vehicles Reported | |
Transportation Profile | CARB TRU Compliance Type | |
Transportation Profile | CARB TRU Non-Compliant Reason | |
Transportation Profile | Cargo Carried | I / U |
Transportation Profile | Carrier Operation | |
Transportation Profile | Carrier Pay To Name | |
Transportation Profile | Carrier Remit To | |
Transportation Profile | Carrier Review Status | I / U |
Transportation Profile | Common Authority Pending | I / U |
Transportation Profile | Common Authority Revocation | I / U |
Transportation Profile | Common Authority Status | I / U |
Transportation Profile | Company Risk | I / U |
Transportation Profile | Connection Status | I / U |
Transportation Profile | Contract Authority Pending | I / U |
Transportation Profile | Contract Authority Revocation | I / U |
Transportation Profile | Contract Authority Status | I / U |
Transportation Profile | Currency | I |
Transportation Profile | D&B DUNS Number | |
Transportation Profile | EPayment Authorized | I |
Transportation Profile | Federal Tax ID | I / U |
Transportation Profile | Fleet Size | I / U |
Transportation Profile | Highway ID | I |
Transportation Profile | Insurance Points | |
Transportation Profile | Insurance Risk | I / U |
Transportation Profile | Last Carrier Review Date | I / U |
Transportation Profile | MC Number | I / U |
Transportation Profile | Mexico State Coverage | |
Transportation Profile | Name | I / U |
Transportation Profile | NSC Number | |
Transportation Profile | NSC Safety Certificate Date | |
Transportation Profile | Number of Drivers | |
Transportation Profile | Operation Points | |
Transportation Profile | Operation Risk | I / U |
Transportation Profile | Other Carrier Capabilities | I / U |
Transportation Profile | Out of Service | I / U |
Transportation Profile | Out of Service Date | I / U |
Transportation Profile | Overall Points | |
Transportation Profile | Overall Risk | I / U |
Transportation Profile | Payment Processor | I |
Transportation Profile | Provincial Authority | |
Transportation Profile | Provincial Permit Number | |
Transportation Profile | RMIS Carrier Payment Option | |
Transportation Profile | RMIS Certified | |
Transportation Profile | RMIS ID | |
Transportation Profile | RMIS Non-Certified Reason | |
Transportation Profile | Safety Points | |
Transportation Profile | Safety Rating | I / U |
Transportation Profile | Safety Rating Date | I / U |
Transportation Profile | Safety Risk | I / U |
Transportation Profile | SCAC | I / U |
Transportation Profile | State DOT Number | I / U |
Transportation Profile | State DOT State | |
Transportation Profile | Total Power Units | I / U |
Transportation Profile | Total US Vehicle Inspections | I / U |
Transportation Profile | US DOT Number | I / U |
Transportation Profile | US State Coverage | |
Transportation Profile | W9 Address | * |
Transportation Profile | W9 City | * |
Transportation Profile | W9 State | * |
Transportation Profile | W9 Postal Code | * |
Transportation Profile | W9 Validated | * |
Transportation Profile | Watchdog Reports |
Table Guide:
I – Insert
U – Update
(1) => Update if the global setting Allow Carrier Address Updates is Checked OR the value in the TMS field is null.
(2) – Update if the value in the TMS field is null.
(3) – Update if there is a value in the response.
(4) – Update if there is a value in the response AND the value in the TMS field is null.
(5) – Update if the global setting Carrier Remit To Sync is checked AND the response has factor company information.
(6) – Update to Pending if RMIS Certified is not Yes.
(7) – Set to Pending by the TMS.
(8) - Set to Email by the TMS.
(*) - If a W9 file is associated with the Carrier, the file is downloaded and attached to the Transportation File. No field values are updated.
(**) - If a file is associated with an Insurance Policy in the Highway system, the file is downloaded and added to the Files section of the Insurance Policy record.
API Field Reference
The table lists the Revenova objects and fields that map to Highway fields when making API requests.
Object | Field | Type | Highway Field |
|---|---|---|---|
Account | Account Name | Name | Received from Highway |
Account | Billing Address | Address | Received from Highway |
Account | Currency | Currency | Set by the TMS. |
Account | Fax | Fax | Received from Highway |
Account | Phone | Phone | Received from Highway |
Account | DBA Name | Text(80) | Received from Highway |
Account | Shipping Address | Address | Received from Highway |
Bank Account | Bank Name | Text(40) | *Received from Highway |
Bank Account | Account Number | Text (Encrypted) (17) | *Received from Highway |
Bank Account | Confirm Account Number | Text (Encrypted) (17) | *Received from Highway |
Bank Account | Routing Number | Text(9) | *Received from Highway |
Carrier Equipment Type | Equipment Type | Master-Detail(Equipment Type) | Received from Highway |
Carrier Equipment Type | Name | Auto Number | Received from Highway |
Carrier Equipment Type | Number | Number(18, 0) | Received from Highway |
Carrier Service | Batch Status Emails | Checkbox | Set to Checked by the TMS. |
Carrier Service | Currency | Currency | Set by the TMS. |
Carrier Service | Enabled | Checkbox | Set to Checked by the TMS. |
Carrier Service | Maximum Weight | Number(18, 0) | Set to 45000 lbs by the TMS. |
Carrier Service | Minimum Weight | Number(18, 0) | Set to 100 by the TMS. |
Carrier Service | Mode | Master-Detail(Mode) | Received from Highway |
Carrier Service | Name | Text(80) | “Account Name + Mode Name” |
Carrier Service | Quote Contact | Lookup(Contact) | Dispatch Contact from the Contact record. |
Carrier Service | Quote Method | Picklist | Set to Email by the TMS. |
Carrier Service | Status Contact | Lookup(Contact) | Status Contact from the Contact record. |
Carrier Service | Status Method | Picklist | Set to Email by the TMS. |
Carrier Service | Tender Contact | Lookup(Contact) | Tendering Contact from the Contact record. See below for more information. |
Carrier Service | Tender Method | Picklist | Set to Email by the TMS. |
Carrier Service | Weight Units | Picklist | Set to lbs by the TMS. |
Contact | Received from Highway | ||
Contact | Name | Name | Received from Highway |
Contact | Phone | Phone | Received from Highway |
Contact | Transportation Role | Picklist (Multi-Select) | Received from Highway |
Insurance Policy | Address | Text Area(255) | Received from Highway |
Insurance Policy | Cancel Date | Date | Received from Highway |
Insurance Policy | City | Text(100) | Received from Highway |
Insurance Policy | Coverage Amount | Currency(18, 0) | Received from Highway |
Insurance Policy | Currency | Currency | Received from Highway |
Insurance Policy | Effective Date | Date | Received from Highway |
Insurance Policy | Expiry Date | Date | Received from Highway |
Insurance Policy | Insurance Company | Text(255) | Received from Highway |
Insurance Policy | Phone | Phone | Received from Highway |
Insurance Policy | Policy Number | Text(80) | Received from Highway |
Insurance Policy | Postal Code | Text(20) | Received from Highway |
Insurance Policy | Source | Picklist | Set as Highway by the TMS. |
Insurance Policy | State/Province | Text(30) | Received from Highway |
Insurance Policy | Type | Picklist | Received from Highway |
Payment Terms | Name | Text(80) | Received from Highway |
Payment Terms | Payment Days Due | Number(3, 0) | Received from Highway |
Payment Terms | Payment Discount % | Percent(3, 2) | Received from Highway |
Payment Terms | **Type | Picklist | Set to Vendor by the TMS. |
Transportation Profile | Agreement Date | Date | Received from Highway |
Transportation Profile | ***Agreement Signed By | Lookup(Contact) | Received from Highway |
Transportation Profile | Agreement Status | Picklist (“Verified”) | Received from Highway |
Transportation Profile | Authority Granted Date | Date | Received from Highway |
Transportation Profile | Authority Risk | Picklist | Received from Highway |
Transportation Profile | Broker Authority Pending | Picklist | Received from Highway |
Transportation Profile | Broker Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Broker Authority Status | Picklist | Received from Highway |
Transportation Profile | Cargo Carried | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Carrier Operation | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Carrier Review Comments | Text Area(255) | Received from Highway |
Transportation Profile | Carrier Review Status | Picklist | Calculated by the TMS. |
Transportation Profile | Common Authority Pending | Picklist | Received from Highway |
Transportation Profile | Common Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Common Authority Status | Picklist | Received from Highway |
Transportation Profile | Company Risk | Picklist | Received from Highway |
Transportation Profile | Company Type | Picklist | Received from Highway |
Transportation Profile | Connection Status | Picklist | Received from Highway |
Transportation Profile | Contract Authority Pending | Picklist | Received from Highway |
Transportation Profile | Contract Authority Revocation | Picklist | Received from Highway |
Transportation Profile | Contract Authority Status | Picklist | Received from Highway |
Transportation Profile | Currency | Currency | Set by the TMS. |
Transportation Profile | Federal Tax ID | Text (Encrypted)(11) | Received from Highway |
Transportation Profile | Fleet Size | Number(18, 0) | Received from Highway |
Transportation Profile | Highway ID | Text(40) (External ID) | Received from Highway |
Transportation Profile | Insurance Risk | Picklist | Received from Highway |
Transportation Profile | Last Carrier Review Date | Date/Time | Received from Highway |
Transportation Profile | MC/MX/FF number | Text(20) | Received from Highway |
Transportation Profile | Name | Text(80) | Received from Highway |
Transportation Profile | Operation Risk | Picklist | Received from Highway |
Transportation Profile | Other Carrier Capabilities | Picklist (Multi-Select) | Received from Highway |
Transportation Profile | Out of Service | Picklist | Received from Highway |
Transportation Profile | Out of Service Date | Date | Received from Highway |
Transportation Profile | Overall Risk | Picklist | Received from Highway |
Transportation Profile | Safety Rating | Picklist | Received from Highway |
Transportation Profile | Safety Rating Date | Date | Received from Highway |
Transportation Profile | Safety Risk | Picklist | Received from Highway |
Transportation Profile | SCAC | Text(6) | Received from Highway |
Transportation Profile | State DOT Number | Text(20) | Received from Highway |
Transportation Profile | Total Power Units | Number(18, 0) | Received from Highway |
Transportation Profile | Total US Vehicle Inspections | Number(18, 0) | Received from Highway |
Transportation Profile | US DOT Number | Text(10) | Received from Highway |
*Fields marked with an asterisk are required.
**Set to “Vendor” when present in the response from Highway.
***If the Contact does not exist for the Carrier, a Contact is created. The Name is set to the signed_by value and the Email is set to the signed_by_email value.
If no Tender or Status Contacts are received from Highway, the Quote Contact is added to the Carrier Service for tendering and status updates.
Reference Values
Cargo Carried
Revenova | Highway |
|---|---|
Agricultural/Farm Supplies | Farm Supplies |
Beverages | Beverages |
Building Materials | Building Materials |
Chemicals | Chemicals |
Coal/Coke | Coal/Coke |
Commodities Dry Bulk | Commodities Dry Bulk |
Construction | Construction |
Drive/Tow Away | Driveaway / Towaway |
Fresh Produce | Fresh Produce |
Garbage/Refuse | Garbage, Refuse, Trash |
General Freight | General Freight |
Grain, Feed, Hay | Grain, Feed, Hay |
Household Goods | Household Goods |
Intermodal Containers | Intermodal Containers |
Liquids/Gases | Liquids/Gases |
Livestock | Livestock |
Logs, Poles, Beams, Lumber | Logs, Poles, Beams, Lumber |
Machinery, Large Objects | Machinery, Large Objects |
Meat | Meat |
Metal: Sheets, Coils, Rolls | Metal: Sheets, Coils, Rolls |
Mobile Homes | Mobile Homes |
Motor Vehicles | Motor Vehicles |
Oilfield Equipment | Oilfield Equipment |
Paper Products | Paper Products |
Passengers | Passengers |
Refrigerated Food | Refrigerated Food |
U.S. Mail | U.S. Mail |
Utilities | Utility |
Water, Well | Water-Well |
Certifications
Revenova | Highway |
|---|---|
CARB-TRU Compliant (California) | CarbTru |
CARB-Truck Compliant (California) | CARB Truck and Bus |
C-TPAT Certified (US) | CTPAT |
Hazmat Certified (US) | PHMSA |
Smartway Certified (US) | SmartWay |
Tanker Endorsed | Tanker Endorsed Drivers |
TSA Certification | TSA |
TWIC Certification | TWIC |
Classification Risks
When the following assessments are received from Highway they are included in the overall calculation for each risk category. Values for each are either True or False.
Classification | Risk Category |
|---|---|
Authority Age Requirement | Authority Risk |
Has DOT or MC Number | Authority Risk |
Has MC Number | Authority Risk |
Has Surety Bond on File | Authority Risk |
Interstate Broker Authority is Active | Authority Risk |
Interstate Carrier Authority is Active | Authority Risk |
Is Authorized for Property | Authority Risk |
No Active Out of Service Orders | Authority Risk |
Safer Operating Status Active | Authority Risk |
AM Best Auto Liability Rating Requirement | Insurance Risk |
BIPD Insurance Limit GTEQ 750,000 | Insurance Risk |
General Liability Requirement | Insurance Risk |
Has Reefer Breakdown | Insurance Risk |
Has VIN if Auto Policy is Scheduled Autos | Insurance Risk |
Multi Currency BIPD Requirement | Insurance Risk |
Multi Currency Cargo Requirement | Insurance Risk |
Trailer Interchange Requirement | Insurance Risk |
Has Been Inspected in the Last Twenty Four Months | Operations Risk |
Has No Published Identity Alerts | Operations Risk |
Has Verified Manually Entered Identifier | Operations Risk |
Has Verified Physical Location Activity | Operations Risk |
Safety Rating Satisfactory or Unrated | Safety Risk |
Equipment Types
Revenova | Highway |
|---|---|
Cargo Vans | cargo_vans |
Double Drop | double_drop_trailers |
Dry Van 53’ | Van_trailers |
Flatbed 3 Axle 53’ | flatbed_trailers |
Heavy Haul Trailers | heavy_haul_trailers |
Intermodal | intermodal_trailers |
Lowboy | lowboy_trailers |
Reefer 53’ | reefer_trailers |
Straight Truck 26’ | straight_box_trucks |
Modes
Revenova | Highway |
|---|---|
Air Freight | air |
Drayage | drayage |
Inland Coastal | inland_coastal |
Intermodal | rail |
LTL | ltl |
Ocean | ocean |
Parcel | parcel |
Truckload | truckload |
Ocean FCL and Ocean LCL Carrier Services are created for a Carrier when an ocean mode is received from Highway.