Border Connect

The integration with Border Connect generates the eManifest to send Trip and Load information for border crossings to and from the United States and Canada. The Border Connect integration is for use with the Fleet Management module in the TMS. Manage eManifest records from the Manifest Builder and Manifest Manger Lightning Web Components.

Manage eManifests with the following border agencies.

• Customs & Border Protection (CBP)

• Canada Border Services Agency (CBSA)

• Release Notification System (RNS, provided by CBSA)

Setup

Complete the following steps for configuring the integration with Border Connect to send and receive customs documents.

Additional Code references and Customs Ports location information may be found by following the links.

• Document, Packaging, Trailer, and other API Codes

• Border Connect Country Codes

• US Customs Ports

• Canadian Customs Ports

• Canadian Customs Ports Sublocations

PAPS and PARS Cover Sheet documents contain barcodes. To generate the documents with barcodes in the TMS, configure the Tec-IT integration.

Enter Credentials

Enable the Border Connect integration by completing the following steps.

1. Navigate to TMS Admin.

2. Select Credentials.

3. Select the Global Services tab.

4. Find Border Connect in the list and open the card.

5. Check the Enabled box.

   1. The Enabled box must be Checked to view the Manifest Builder icon on the Trip Planner LWC.

   2. The Enabled box must be Checked to view the Manifest Builder on the Manifest Manger.

6. Any value may be entered in the User ID text field.

7. Enter the Company Key into the Password 1 text field.

8. Click the Save button when finished.

9. Click the Initialize Border Connect Data button to add US Customs Port and Canadian Customs Port Accounts to the org.

Set CRUD Access

Update profiles and/or permission sets to set the following CRUD access.

The following objects should be set to Read-Only for most users completing Fleet Management tasks. Users should not have direct control to create, edit, or delete fields on these objects.

• EManifest Transaction

• RNS Notification

• ACE Notification

Background processes create and edit these fields as necessary.

Create an API user

Create a new user for the Border Connect integration.

Multiple integrations may require an API User. If an API User already exists in an org., add the Border Connect API User permission set to the existing API User and skip the steps to create a new API user.

1. Navigate to Setup and then search for and click the Users link.

2. Click the New User button and add the following:

   1. First Name: API

   2. Last Name: User (The First and Last Name fields may be any value, but should reference the API User for clarity.)

3. Email: Set to the system admin's email.

4. Username: Change if necessary.

5. User License: Salesforce Integration

6. Profile: Minimum Access - API Only Integrations

7. Click Save.

• Add the Permission Set Border Connect 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.

See Salesforce documentation for additional information on creating API Users.

Verify Connected App

Verify that the Border Connect API Connection Connected App is created and available in the org. Complete the following steps to finish configuring the connected app.

1. From Setup → App Manager find Border Connect API Connect.

2. From the drop-down, select Edit.

3. Check the Enable Client Credentials Flow box.

4. Click Save.

5. Return to Setup → App Manager and find the Border Connect API Connect app.

6. From the drop-down, select Manage.

7. Choose the Edit Policies button.

8. In the Client Credentials Flow section, find the Run As field.

9. Click the Run As Lookup button.

10. Select the Border Connect API User created above.

11. Click Save.

Create a Connected app by following the steps below. Skip these steps when the Border Connect API Connection App already exists.

1. Create the Connected App.

   1. Navigate to Setup and search for External Client Apps and select the Settings link.

   2. From the Connected Apps section, choose On for Allow creation of connected apps.

      1. Click the Enable button on the modal to create Connected Apps.

   3. Click the New Connected App button.

      

2. Select Create a Connected App and choose Continue.

3. Enter the following information into the fields.

   1. Connected App Name: Border Connect API

   2. API Name: Auto-Generated based on the Connected App Name.

   3. Contact Email: System admin’s email.

   4. Enabled OAuth Setting: Checked.

   5. Callback URL: https://login.salesforce.com/.

   6. Selected OAuth Scopes: Add Full Access (full), Manage user data via APIs (api), and Perform requests at any time (refresh_token, offline_access).

   7. Enable Client Credentials Flow: Checked.

4. Click Save.

   

5. From the list of apps, find the new Border Connect API app.

6. Click the Manage button from the drop-down.

7. Choose the Edit Policies button.

8. From the Client Credentials Flow section find the Run As field and choose the API User.

9. Click Save.

Consumer Key and Secret, 18-Character Org Id

1. Navigate to Setup and then search for and click the App Manager link.

2. In the Border Connect API row click the arrow and select to View.

3. 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

1. From the Setup drop-down, choose Developer Console.

2. Select the Query Editor tab.

3. Enter SELECT Id from Organization into the field.

4. Click the Execute button.

5. Copy and Save the 18-Character Organization Id.

When complete, open a Case with Revenova Support and include the following information to complete Border Connect setup.

• Company Key

• Login URL for the Org

• 18-Character Organization ID

• Consumer Key

• Consumer Secret

Configure Email Services

Configure the Border Connect Inbound Documents Email Service to receive documents from Border Connect.

1. Navigate to Setup and search for Custom Code and select Email Services.

2. Choose Border Connect Inbound Documents.

   1. The Email Service must be named Border Connect Inbound Documents. Any other name generates an error when attempting to receive documents from Border Connect.

3. In the Email Addresses section, click the New Email Address button.

4. Enter an Email Address Name (bc_docs is shown above).

5. Delete the value in the Email Address field.

6. Check the Active box.

7. Delete everything in the Accept Email From field.

8. Click Save.

   Salesforce creates and adds the domain to the end of the Email Address field.

   Border Connect returns an error for long email addresses. Salesforce appends a lengthy domain and to meet the Border Connect limit, the above example is a recommended length.

Other Setup

Hazardous Materials/Single Currency Orgs

ACE Shipments that contain Hazardous Materials require an insurance policy to send to Customs. Border Connect requires a Coverage Amount field in USD. The Carrier Transportation Profile associated with the Driver must have an Insurance Policy. An error is generated when an Insurance Policy is not included. Border Connect requires an Insurance Policy with the Coverage Amount field in USD.

Single-currency orgs that use a currency other than USD must configure the TMS Admin field Current Exchange Rate to USD to send the correct Coverage Amount.

1. Navigate to TMS Admin → Configuration, and find the Current Exchange Rate to USD field.

2. Enter the exchange rate to convert the currency to USD.

3. Click Save.

Multi-currency orgs use Salesforce conversions to calculate the insurance coverage in USD. Single currency orgs use the TMS Admin → Configuration field.

Canadian Sublocations

The Border Connect integration supports many Canadian Port sublocations. Sublocations are required when the Shipment Type is In-Bond and the direction is ACI. There are over 1000 sublocations available via Border Connects API. Follow the steps below to create sublocations.

It is recommended to create Account records with the Port Code in the name. This allows for searching by Port Code and returning results when building Trip Plans.

Create child records for each CA Port Sublocation Code as needed.

1. Create an Accounts for the sublocation with a TMS Type of Customs Port.

2. The Parent Account field is a lookup field to the corresponding Customs Port Account. Search for the appropriate Customs Port Account.

3. From the sublocation Transportation Profile, add the CA Port Code. The CA Port Code should match the Parent Account CA Port Code.

4. Enter the CA Port Sublocation Code. The CA Port Sublocation Code should match the code provided by Border Connect for that location.

5. Save the record.

Create child records for each CA Port Sublocation Code as needed.

CA Port Location Notes

• Not all sublocations correspond to a Parent Customs Port. Reference the list of sublocations provided by Border Connect.

• It is recommended to create Account records with the Port Code in the name. This allows for searching by Port Code and returning results when building Trip Plans.

See the list of supported Sublocations.

Sandbox Setup

In order to test the Border Connect integration in a sandbox, all of the previous setup is required. Open a case including all required information with Revenova support to complete the Border Connect setup for the sandbox.

PAPS/PARS Cover Sheet Setup

Loads with a Shipment Type of PAPS or PARS may be generate the following Cover Sheets within Revenova.

The field mapping for both documents follows the general layout.

• Top section: The Company Name is the Transportation Profile defined in the TMS Admin Default Transportation Profile field.

• Middle section: The Border is the Port of Arrival defined in the Manifest Builder and Manifest Manager.

  • The ETA is the Estimated Port of Arrival Date/Time defined in the Manifest Builder and Manifest Manager.

  • When a Load is selected, it is possible to override the Customs Broker Email Address used in the PARS Cover Sheet. By default, it is the email address from the Customs Broker Contact with a Transportation Role of ACI.

• Bottom section: Contact information is, by default, the User that clicks the Submit button to generate the document. There is a User lookup field that allows for manually searching and selecting a User to render as the Contact for that document.

• Footer text: This text is configurable in Document Options.

• PAPS Cover Sheet

  • PAPS Cover Sheets are only applicable to Loads that are selected as a PAPS Shipment Type.

  • The PAPS Cover Sheet is generated by the TMS. Customize this document in Document Options.

  • The PAPS number is listed with a barcode generated with the Tec-IT integration. Setup the integration to include barcodes on PAPS Cover Sheet documents.

    • If the Tec-IT integration is not enabled, the section of the document where the barcode appears is blank.

    • The space on the document to accommodate the barcode and PAPS number is approximately 3×1 inch in size.

    • Barcodes on PAPS Cover Sheets are recommended to be a Code 39 format.

  • The Customs Broker Contact included on a Load is displayed on the PAPS Cover Sheet for Contacts with the ACE Transportation Role.

    • When the Customs Broker Contact has an Account Broker Filer Code, that field is included in the ACE eManifest Message payload.

  • The PAPS Cover Sheet is printed and included with other documentation the Driver brings to the border.

• PARS Cover Sheet

  • PARS Cover Sheets are only applicable to Loads that are selected as a PARS Shipment Type.

  • The PARS Cover Sheet is generated by the TMS. Customize this document in Document Options.

  • The PARS number is listed with a barcode generated with the Tec-IT integration. Setup the integration to include barcodes on PARS Cover Sheet documents.

    • If the Tec-IT integration is not enabled, the section of the document where the barcode appears is blank.

    • The space on the document to accommodate the barcode and PARS number is approximately 3×1 inch in size.

    • Barcodes on PARS documents for ACI are Code 128.

  • The Customer Broker Contact included on a Load is displayed on the PARS Cover Sheet for Contacts with the ACI Transportation Role.

  • The PARS Cover Sheet is printed and included with other documentation the Driver brings to the border.

A8A Form/ACE Manifest Cover Sheet/ACI Manifest Cover Sheet

The A8A Form, ACE and ACI Manifest Cover Sheet documents are generated by Border Connect. Making any changes to an eManifest requires the user to perform the Validate, Send, or Update functions before submitting a document request for these document types. Document requests do not contain shipment or trip information. Border Connect must first receive and process the eManifest updates in their system before these documents accurately reflect any eManifest changes.

Travel Credentials

Travel Credentials contain a Driver’s travel documentation. These are the documents that a Driver presents to the Customs Agent when crossing the border. The first credential sent is always Fast Card for Drivers that are Fast Card approved.

Set the priority for Travel Credentials to send to Border Connect and the Border Agency.

1. From Setup → Object Manager, find the Travel Credential object.

2. Select the Fields & Relationships link.

3. Click the Type field.

4. In the Values section, choose the Reorder button.

5. Select values and click the up and down buttons to order the credentials.

   1. Values at the top of the list are checked and sent first.

   2. Values near the bottom of the list are rarely sent.

6. Click Save.

If a Fast Card is present, no travel credentials are required. Fast Card related fields are sent as part of the Driver section of the eManifest.

Driver records include the following license and commercial license fields.

• CDL #

• CDL Country

• CDL Expiration Date

• CDL State/Province

• Drivers License Number

• Drivers License Country

• Drivers License Expiration Date

• Drivers License State/Province

If a Driver record does not have a Travel Credential for Commercial Driver’s License, these fields are included in the payload sent to Border Connect. Driver records may contain both license fields and license Travel Credentials. In this case, the Travel Credential record is prioritized over the License fields on the Driver record. When CDL fields are present on the Driver object (no Fast Card), the CDL information is always sent as the first Travel Credential regardless of picklist order.

Add Travel Credentials for Drivers from the related list on each Driver or Contact record.

RNS Notifications

Receive RNS Notifications by creating an RNS profile in the Border Connect account. Navigate to Border Connect and find Company Preferences. Set the API Subscription for all RNS Shipments to Yes.

Contact Border Connect by email to receive and complete additional documentation for enabling RNS Notifications. At this time, Border Connect does not charge an additional fee to enable RNS Notifications.

Border Connect API Calls

The integration with Border Connect consists of 2 separate API endpoints.

1. The Send Operation sends eManifest information, requests that the eManifest be forwarded to the appropriate Customs Agency, updates and deletes eManifests, or requests PDF Documents. (POST)

2. The Receive Operation receives all request messages from Border Connect. (GET)

ACE and ACI eManifests must be filed with the Customs Agency at least one hour before a Truck arrives at the border. eManifests may be filed up to 30 days in advance.  A driver arriving within 60 minutes of filing the eManifest must have a Fast Card certification. Fast Card certified drivers may arrive 30 minutes after filing an ACE or ACI eManifest. An ACE or ACI eManifest that is canceled or resubmitted restarts the 60-minute timer.

• Carriers must provide the necessary Customs documentation to the Customs Broker filing the clearance with the Border Agency. The Customs Broker ensures the PAPS or PARS Numbers (Cargo Control Number) on the eManifest matches the Manifest to clear the freight. Both eManifest and Manifest must be filed with the Border Agency before the Driver can cross the border.  Border Customs Agents check the Driver’s printed documentation against the ACE or ACI eManifest filed via the Border Connect API.

• Carrier PAPS or PARS Cover Sheets should be sent to the Customs Broker that is filing the Manifest.

• Border Connect does not support special characters. Fields that contain special characters and are sent to Border Connect generate an error that displays in the Manifest Builder.

• When creating custom Equipment Type records, specify the Border Connect Trailer Code to ensure the proper equipment type is sent in the API calls. The default selection is for Other. If no value is included in this field, the default Other equipment type is sent in API calls.

Shipment payloads are configured with the following logic.

• The SCAC (ACE) or Carrier CBSA (ACI) fields are included in the EManifest Trip Identifier sent in Border Connect API calls. However, the Trip Identifier field is not saved in the TMS with the SCAC or Carrier CBSA values at the beginning.

• eManifest Shipments include all Loads from the Trip Plan Leg. When the Load in the Trip Plan Leg is a Carrier Load in a Freight Plan, multiple customer Loads are included. The Stop and Line Item information from each customer Load is sent.

  If a Stop or Line Item was completed before crossing the border, that Stop or Line Item is not included in the eManifest since it is not on the truck at the time of border crossing.

• All Drivers from the Trip Plan Segment are included in the eManifest Shipment payload.

• All Travel Credentials for Driver and Passengers are included in the eManifest Shipment payload.

  • Drivers without a Fast Card require Travel Credentials.

    • The first 3 non-expired Travel Credentials as set in the Type picklist are included in the payload. Set the picklist order to determine priority.

    • 2 Travel Credentials are required.

      • 1 must be a Drivers License (Commercial, Enhanced, or Standard). The Drivers License is sent as the first credential.

      • 1 can be any other Type not a Drivers License. Before sending the payload, the Type is checked to prevent duplicate credentials.

    • Travel Credentials in the payload are ordered by picklist value first. Then by Expiration Date, the most distant future date is given priority.

    • Expired Travel Credentials are never included in the Shipment payload.

  • The Shipment payload only includes the Fast Card when the Driver has a Fast Card.

• All Trailer Fleet Assets from the Trip Plan Leg are included in the eManifest Shipment payload.

  • The maximum allowed number of Trailer Fleet Assets in a Shipment is 3.

ACE (Entering the US)

Shipments entering the United States from Canada require eManifest information sent to the CBP prior to crossing the border. The following calls to Border Connect API endpoints are controlled by buttons on the Manifest Builder LWC. Fields are sent to meet US CBP regulations.

• ACE Shipments are composed of a Trip and a Shipment. The Trip includes the Truck, Trailer, and Driver TMS data. The Shipment includes the commercial invoice information from the Load, Stop, and Line Item TMS data.

• ACE Shipments containing multiple Stops send the first Stop location as the Shipper. Any additional pickup Stops are sent as Ship From type third parties. The Ultimate Consignee is listed as the Consignee unless the Load does not have an Ultimate Consignee. In such cases, the last Stop Account is sent as the Consignee. If the Load has multiple delivery Locations besides the Ultimate Consignee, those Stop locations are sent as Ship To type third parties.

• The Broker Filer Code field is a 3-character code on an Account record that is issued by US CBP. When the Customs Broker field on a Load has a value, the Broker Filer Code is included in the ACE Manifest Request. See additional information for setting the default Customs Broker on Loads.

  • The Customs Broker Port Location is blank by default, but when the Customs Broker field on a Load has a value, that value is entered in the Port Location field and included in the ACE Manifest Request. This field is used for routing the Manifest information to the correct office of the Customs Broker. The Customs Broker must be approved to operate at the selected Customs Port. If not, Border Connect returns an error that is displayed in the Manifest Builder.

For ACE Direction Manifests containing IIT (Instruments of International Trade) with no associated Load and the driver is not Fast Card Approved, a US address is sent that represents the destination of the driver after they cross the border. The US address sent is the End Type of the Trip Plan Leg after the border crossing in the Trip Plan.

Loads with a Shipment Type of Section 321 or Section 321 with Considerations require the Country of Origin field.

Add additional countries and their respective Border Connect codes as necessary. Follow the instructions here.

The Validate button on the Manifest Builder sends the ACE eManifest Message with the following values. This action sends the eManifest to Border Connect only and not to the Customs Agency.

• Operation is set to Create.

• Auto-send is set to False.

• Data is set to ACE_TRIP.

• Data on the Shipment is set to ACE_SHIPMENT.

The Validate button is only available when the EManifest Status is None, Validated, Invalidated, or Revoked. If an eManifest already has a Status of Validated, the Revoke transaction is sent first to remove the existing eManifest. The new ACE eManifest Message is then sent.

The Send button sends the eManifest to Border Connect and the Customs Agency systems.

• If the eManifest Status is Validated, the ACE Send Request Message is sent with the following values.

  • The Type is set to COMPLETE_TRIP_AND_SHIPMENTS.

  • Data is set to ACE_SEND_REQUEST.

  • bundleTripAndShipments is set to True.

  The ACE Send Request Message is a simplified payload that instructs Border Connect to forward the eManifest information already received to the Customs Agency systems.

• If the eManifest Status is None or Revoked, the ACE eManifest Message is sent with the following values.

  • Data is set to ACE_TRIP.

  • Data on the Shipment is set to ACE_SHIPMENT.

  • Auto-send is set to True.

  The ACE eManifest Message is the same payload that is sent when pressing the Validate button except Auto-send is set to True.

The Send button is only available when the eManifest Status is None, Revoked, or Validated.

The Update button on the Manifest Builder sends the ACE eManifest Message with the following values. The action sends the eManifest to Border Connect and Customs Agency systems.

Operation is set to Update.

Auto-Send is set to True.

Data is set to ACE_TRIP.

Data on the Shipment is set to ACE_SHIPMENT.

The Update button is only available when the EManifest Status is Sent, Accepted, or Rejected.

The Revoke button on the Manifest Builder sends the ACE eManifest Message with the following values. This action deletes the eManifest from the Border Connect and Customs Agency systems.

• Operation is set to Delete.

• Auto-Send is set to True.

The Revoke button is only available when the EManifest Status is Validated, Sent, Accepted, or Rejected.

Calls to Border Connect to Save, Validate, Send, or Update an ACE eManifest must meet the following criteria or will generate an error.

• The Estimated Arrival Date/Time field in the future.

• A SCAC value should be entered on the Transportation Profile associated with the Driver on the eManifest.

ACE eManifest Message

When the ACE eManifest Message API call contains the Auto-send value True, the eManifest information is sent to Border Connect and the Customs Agency Systems. The ACE Send Request API call sends the ACE eManifest to U.S. Customs and Border Patrol.

Fields sent in the ACE eManifest Message payload.

*Fields marked with an asterisk are required.

Most Commonly the PAPS number is the Cargo Control Number but other Control number types are possible.

Border Connect and the Customs Agencies expect Line Item Packaging Unit and PU Count fields. If not present, the HU Count is sent in place of the PU Count and Handling Units are sent in place of Packaging Units.

Sample ACE eManifest Message payload.

{
	"data": "ACE_TRIP",
	"sendId": "001",
	"companyKey": "c-9000-2bcd8ae5954e0c48",
	"operation": "CREATE",
	"tripNumber": "AAAA123457A",
	"usPortOfArrival": "0101",
	"estimatedArrivalDateTime": "2014-07-31 04:45:00",
	"truck": {
		"number": "2013",
		"type": "TR",
		"vinNumber": "AG12XXXXXXXXXF",
		"licensePlate": {
			"number": "TEMP5",
			"stateProvince": "ON"
		}
	},
	"trailers": [
		{
			"number": "0456",
			"type": "TL",
			"licensePlate": {
				"number": "JV2012",
				"stateProvince": "ON"
			}
		}
	],
	"drivers": [
		{
			"driverNumber": "D004",
			"firstName": "Michael",
			"lastName": "Dorn",
			"gender": "M",
			"dateOfBirth": "1970-01-01",
			"citizenshipCountry": "CA",
			"fastCardNumber": "42705555555501"
		}
	],
	"shipments": [
		{
			"data": "ACE_SHIPMENT",
			"sendId": "001",
			"companyKey": "c-9000-2bcd8ae5954e0c48",
			"operation": "CREATE",
			"type": "PAPS",
			"shipmentControlNumber": "AAAAA754321",
			"provinceOfLoading": "NU",
			"shipper": {
				"name": "Art place",
				"address": {
					"addressLine": "1234 Vancity",
					"city": "Vancouver",
					"stateProvince": "BC",
					"postalCode": "V6H 3J9"
				}
			},
			"consignee": {
				"name": "Elk Corp of Texas",
				"address": {
					"addressLine": "401 Weavertown Rd",
					"city": "Myerstown",
					"stateProvince": "PA",
					"postalCode": "17067"
				}
			},
			"commodities": [
				{
					"loadedOn": {
						"type": "TRAILER",
						"number": "0456"
					},
					"description": "Books",
					"quantity": 35,
					"packagingUnit": "BOX",
					"weight": 1500,
					"weightUnit": "L"
				}
			]
		}
	],
	"autoSend": false
}

Errors returned from the ACE eManifest Message are displayed in the Manifest Builder.

The following fields are returned in the ACE Response payload.

*Matches the response to the existing Revenova record. This field does not appear for ACE shipments.

ACE Send Request

In Revenova, the ACE Send Request is used when the eManifest was previously sent to Border Connect. The ACE Send Request Message is a simplified payload that references the tripNumber and instructs Border Connect to forward that eManifest information to the Customs Agency systems.

When Estimated Arrival Date/Time field is within 1 hour of the current time, users are presented a warning. The warning occurs when performing Save, Validate, Send, or Update actions. Potential penalties may apply when arriving at the border within 1 hour of sending the eManifest to the Border Agency.

Click OK to submit the eManifest if the Driver is Fast Card approved to arrive at the border 30 minutes early.

Click Cancel to prevent sending the eManifest. Adjust the date and time as necessary and proceed with sending the eManifest to the Border Agency.

Fields sent in the ACE Send Request payload

*Fields marked with an asterisk are required.

Sample ACE Send Request Payload

{
	"data": "ACE_SEND_REQUEST",
	"sendId": "1302213",
	"companyKey": "c-9000-2bcd8ae5954e0c48",
	"type": "COMPLETE_TRIP_AND_SHIPMENTS",
	"tripNumber": "AAAA123457A"
}

ACE Notification Response

U.S. Customs and Border Protection (CBP) provides Customs clearance status updates to Carriers and Customs Brokers. Most commonly, ACE messages from Border Connect are for Carriers to verify a PAPS Shipment was cleared by a Customs Broker before crossing the border.

ACE Notifications are only received for ACE direction border crossings.

ACE Notifications are displayed in a drop-down in the Manifest Builder. When multiple notifications are received, each ACE Notification Status is contained in a dropdown. Notifications are shown most recent to oldest. Loads are separated by tabs.

Once an eManifest is submitted, ACE Notifications are sent to the TMS automatically. ACE Notifications include the following fields and display in the Manifest Builder.

• Record Name

• Created Date

• Entry Number

• Port Code

ACI (Entering Canada)

Shipments entering the Canada from the United States require eManifest information to be sent to the CBSA before crossing the border. The following calls to Border Connect API endpoints are controlled by buttons on the Manifest Builder LWC. Fields are sent to meet CBSA regulations.

• ACI Shipments are composed of a Trip and a Shipment. The Trip includes the Truck, Trailer, and Driver TMS data. The Shipment includes the commercial invoice information from the Load, Stop, and Line Item TMS data.

• ACI Shipments use Ultimate Consignee and Delivery Destinations information to determine delivery locations. 1 location is the Ultimate Consignee and the Delivery Destinations is an array of location information.

  • Delivery Destinations do not and should not include the Ultimate Consignee Account.

• Follow the guidelines below when creating ACI Shipments for Loads with multiple Stops.

  • Per CBSA guidelines, each Load in the ACI Shipment is limited to 1 Shipper or pickup Stop. In general, the CBSA advises that in cases with multiple Shippers, the ACI Shipment should be entered as multiple Loads.

    • If the Load has multiple pickup Stops, the first Load Stop is sent as the Shipper. No other pickup Stops are sent in the API.

  • Set the Ultimate Consignee field on the Load to match the consignee on Customs documents.

    • When the Ultimate Consignee field has a value, that Account is the Consignee.

      • Any additional delivery Stops are included as Delivery Destinations.

      • The Account SFID for the Ultimate Consignee is checked against each Delivery Destination to confirm they are not the same.

    • When the Ultimate Consignee field does not have a value, the last Stop is sent as the Consignee. All other delivery Stops are sent as Delivery Destinations.

  • If goods are on a single Bill of Lading, they should generally appear on the eManifest as a single Load.

  • The Shipper on the Bill of Lading sent to Customs should be listed as the Shipper on the eManifest.

• ACI Direction Manifests containing IIT (Instruments of International Trade) with no associated Load and the Driver is not Fast Card approved send other address information. The Driver’s Canadian address after crossing the border is sent as the End Type of the leg after the border crossing in the Trip Plan.

• A Cargo Exemption of IIT is added to the eManifest for either the Truck or the Trailer/Container. In instances where the truck is a box truck, the exemption should be declared on the Truck.

The Validate button on the Manifest Builder sends the ACI eManifest Message with the following values. This action sends the eManifest to Border Connect only and not to the Customs Agency.

• Operation is set to Create.

• Auto-send is set to False.

• Data is set to ACI_TRIP.

• Data on the Shipment is set to ACI_SHIPMENT.

The Validate button is only available when the EManifest Status is None, Validated, Invalidated, or Revoked. If an eManifest already has a Status of Validated, the Revoke transaction is sent first to remove the existing eManifest. The new ACI eManifest Message is then sent.

The Send button sends the eManifest to Border Connect and the Customs Agency systems.

• If the eManifest Status is Validated, the ACI Send Request Message is sent with the following values.

  • The Type is set to COMPLETE_TRIP_AND_SHIPMENTS.

  • Data is set to ACI_SEND_REQUEST.

  • bundleTripAndShipments is set to True.

  The ACI Send Request Message is a simplified payload that instructs Border Connect to forward the eManifest information already received to the Customs Agency systems.

• If the eManifest Status is None or Revoked, the ACI eManifest Message is sent with the following values.

  • Data is set to ACI_TRIP.

  • Data on the Shipment is set to ACI_SHIPMENT.

  • Auto-send is set to True.

  The ACI eManifest Message is the same payload that is sent when pressing the Validate button except Auto-send is set to True.

The Send button is only available when the eManifest Status is None, Revoked, or Validated.

The Update button on the Manifest Builder sends the ACI eManifest Message with the following values. The action sends the eManifest to Border Connect and Customs Agency systems.

Operation is set to Update.

Auto-Send is set to True.

Data is set to ACI_TRIP.

Data on the Shipment is set to ACI_SHIPMENT.

The Update button is only available when the EManifest Status is Sent, Accepted, or Rejected.

The Revoke button on the Manifest Builder sends the ACI eManifest Message with the following values. This action deletes the eManifest from the Border Connect and Customs Agency systems.

• Operation is set to Delete.

• Auto-Send is set to True.

The Revoke button is only available when the EManifest Status is Validated, Sent, Accepted, or Rejected.

Calls to Border Connect to Save, Validate, Send, or Update an ACI eManifest must meet the following criteria or generate an error.

• The Estimated Arrival Date/Time field is in the future.

• A SCAC value should be entered on the Transportation Profile associated with the Driver on the eManifest.

ACI eManifest Message

When the ACI eManifest Message API call has the Auto-send value set to True, the eManifest information is sent to Border Connect and the Customs Agency systems. The ACI Send Request API message sends the eManifest information to the CBSA.

Fields sent in the ACI eManifest Message payload.

*Fields marked with an asterisk are required.

**If the Load Ultimate Consignee is blank, the last Stop Shipping/Receiving Contact information is sent instead.

***If the Load Ultimate Consignee is blank, the last Stop location is sent. If the Load Ultimate Consignee field is entered, all delivery destinations that are not the Ultimate Consignee location are sent.

Border Connect and the Customs Agencies expect Line Item Packaging Unit and PU Count fields. If not present, the HU Count is sent in place of the PU Count and Handling Units are sent in place of Packaging Units.

Sample ACI eManifest Message Payload

{
	"data": "ACI_TRIP",
	"sendId": "001",
	"companyKey": "c-9000-2bcd8ae5954e0c48",
	"operation": "CREATE",
	"tripNumber": "1234923ASDF",
	"portOfEntry": "0440",
	"estimatedArrivalDateTime": "2014-12-08 05:45:00",
	"truck": {
		"number": "10",
		"type": "TR",
		"vinNumber": "23XXXXXX54XX7",
		"dotNumber": "000001",
		"insurancePolicy": {
			"insuranceCompanyName": "ABC Insurance",
			"policyNumber": "123456789",
			"issuedDate": "2010-10-20",
			"policyAmount": 1000000
		},
		"licensePlate": {
			"number": "TRK1NG",
			"stateProvince": "ON"
		}
	},
	"trailers": [
		{
			"number": "23411",
			"type": "TL",
			"licensePlate": {
				"number": "OKATE1",
				"stateProvince": "MI"
			}
		}
	],
	"drivers": [
		{
			"driverNumber": "JD",
			"firstName": "John",
			"lastName": "Doe",
			"gender": "M",
			"dateOfBirth": "1980-07-14",
			"citizenshipCountry": "US",
			"travelDocuments": [
				{
					"number": "23423562",
					"type": "5K",
					"stateProvince": "MI"
				},
				{
					"number": "23423562",
					"type": "6W",
					"stateProvince": "MI"
				}
			]
		}
	],
	"shipments": [
		{
			"data": "ACI_SHIPMENT",
			"sendId": "001",
			"companyKey": "c-9000-2bcd8ae5954e0c48",
			"operation": "CREATE",
			"shipmentType": "PARS",
			"loadedOn": {
				"type": "TRAILER",
				"number": "23411"
			},
			"cargoControlNumber": "1234PARS34213341",
			"referenceOnlyShipment": false,
			"portOfEntry": "0440",
			"releaseOffice": "0440",
			"estimatedArrivalDate": "2014-12-08 05:45:00",
			"cityOfLoading": {
				"cityName": "New York",
				"stateProvince": "NY"
			},
			"consolidatedFreight": false,
			"shipper": {
				"name": "Hazmat Wholesale",
				"address": {
					"addressLine": "1234 New York ave",
					"city": "New York",
					"stateProvince": "NY",
					"postalCode": "12345"
				}
			},
			"consignee": {
				"name": "Canadian Lava Co.",
				"address": {
					"addressLine": "15 North Town Line Unit 68B",
					"city": "River Canard",
					"stateProvince": "ON",
					"postalCode": "N9J2W2"
				}
			},
			"commodities": [
				{
					"description": "Plywood",
					"quantity": 900,
					"packagingUnit": "PCE",
					"weight": "35005",
					"weightUnit": "LBR"
				}
			]
		}
	],
	"autoSend": false
}

Errors returned from submitting an ACI eManifest Message are displayed in the Manifest Builder.

Fields returned in the ACI eManifest Message response payload.

*Matches the response to the existing Revenova record. This field does not appear for ACE shipments.

ACI Send Request

In Revenova, the ACI Send Request is used when the eManifest was previously sent to Border Connect. The ACI Send Request Message is a simplified payload that references the tripNumber and instructs Border Connect to forward that eManifest information to the Customs Agency systems.

When Estimated Arrival Date/Time field is within 1 hour of the current time, users are presented a warning. The warning occurs when performing Save, Validate, Send, or Update actions. Potential penalties may apply when arriving at the border within 1 hour of sending the eManifest to the Border Agency.

Click OK to submit the eManifest if the Driver is Fast Card approved to arrive at the border 30 minutes early.

Click Cancel to prevent sending the eManifest. Adjust the date and time as necessary and proceed with sending the eManifest to the Border Agency.

Fields sent in the ACI Send Request payload

*Fields marked with an asterisk are required.

Sample ACI Send Request Payload

{
	"data": "ACI_SEND_REQUEST",
	"sendId": "1302213",
	"companyKey": "c-9000-2bcd8ae5954e0c48",
	"tripNumber": "1234923ASDF",
	"type": "ORIGINAL",
	"bundleTripAndShipments": true
}

RNS Notification Response

The Canada Border Services Agency (CBSA) provides Customs clearance status updates to Carriers, Customs Brokers, and more with the Release Notification System (RNS). Most commonly, RNS messages from Border Connect are for Carriers to verify a PARS Shipment was cleared by a Customs Broker before crossing the border. Border Connect requires customers to sign up for RNS Notifications at no additional cost.

RNS Notifications are only received for ACI direction border crossings.

RNS Notifications are displayed in a drop-down in the Manifest Builder. When multiple notifications are received, each RNS Notification Status is contained in a dropdown. Notifications are shown most recent to oldest. Loads are separated by tabs.

Once an eManifest is submitted, RNS messages are sent to the TMS automatically. RNS Notifications include the following fields and display in the Manifest Builder.

• Record Name

• Created Date

• Service Option

• Transaction Number

• Port Code

The Port Code field is only displayed when returned from Border Connect.

The following fields are returned in RNS Notification responses.

Sample RNS Notification Response Payload

{
	"data": "RNS_SHIPMENT",
	"cargoControlNumber": "1234PARS382666",
	"transactionNumber": "17889003009937",
	"driverName": "Andrew Robinson",
	"serviceOption": {
		"number": "117",
		"name": "PARS, paper"
	},
	"releaseOffice": {
		"number": "0453",
		"name": "WINDSOR AMBASSADOR BRIDGE"
	},
	"status": {
		"dateTime": "2014-11-23 03:11:00",
		"releaseCode": {
			"number": "9",
			"shortName": "Declaration Accepted",
			"longName": "Declaration Accepted, Awaiting arrival of goods"
		}
	}
}

Border Connect Code Reference

The tables below contain the codes returned from Border Connect from API calls.

RNS Status Codes

Release Codes

Release Codes are stored in the Status field picklist.

Service Options

Service Options are stored in the Service Option field picklist.

Trip Status Codes

Shipment Type Data Values

Shipment Status Codes

Trailer Type Codes

Travel Credential Type Codes

ACI Cargo Exemption Codes

Packaging Unit Codes

Acceptable Shipment Release Types

Third Party Type Codes