This document explains how Highway carriers are integrated into our system, how updates are managed, and how carrier details are displayed within Salesforce.

——————————————————————————————————————————-

1. System Flow

1.1 Initial Carrier Sync

• We begin by syncing Highway carriers with the system.
• We are currently syncing 3,355 carriers into the system.

1.2 Onboarding Packets Sync (Hourly)

• Every hour, we call the Onboarding Packet endpoint.
  
• New packets are inserted into the system based on their MC Number to prevent duplicate carriers.
  
• Once processed, packets are marked accordingly to ensure they are not fetched again in future requests.
  

1.3 Carrier Alerts Sync (Hourly)

• We also call the Carrier Alerts endpoint every hour to check for carrier updates.
  
• Updates can include changes to existing carrier details or entirely new carriers.
  
• We insert updated or new carriers based on their MC Number, avoid duplicates, and mark them as processed to exclude them from subsequent requests.

2 .Viewing Carrier Details

1. On the Home > Carrier page, select a carrier from the list view.
   

2. Click on a carrier to open its detail page.

You will see that we store carrier details, including:

2.1 General Carrier Information

• We set Dispatch phone and Dispatch email to Phone and Email fields. 

2.2 Address Information (Physical & Mailing)

• Both Physical and Mailing addresses are stored.

• A dedicated Mailing Address section has been added to Salesforce to store this data.

2.3 Accounting contacts.

• The Corporate Contacts section has been replaced with Claim Contacts.

2.4 Payment information

• Payment data is sourced from the Onboarding Packets endpoint.
  
• Currently, the endpoint does not return data, so the Payment Information section is empty.

• Once data is received, it will be updated automatically.

2.5 Insurance(Cargo , Liability).

• Both Cargo and Liability insurance details are stored.
  
• The first column represents Cargo insurance, and the second column represents Liability insurance.

3. API Key and Configuration

We created two Custom Metadata Types : stagingHighway and ProdHighway. These store the API keys and endpoint URLs for both the staging and production environments.

To ensure security and maintainability, sensitive information such as API keys is not hardcoded in the codebase.

3.1  click on the home page .

3.2  click on setup .

3.3  in setup page search for Custom Metadata Types.

3.4  you will see both stagingHighway and ProdHighway.

3.5  Click Manage Records to view the stored data.