Overview
Breakthrough Fuel (BTF) based fuel surcharges are supported for stored rate customer quotes. Breakthrough Fuel provides the ability to capture daily fuel price changes to ensure they are paying fair market prices on the Expected Ship Date of their Loads using precise Lane information to arrive at the Fuel cost.
Breakthrough’s Load Lookup API provides partner organizations the ability to request fuel amounts for official loads that are already in the FELIX system. This API does not insert new shipments, nor does it perform a fuel calculation. It simply returns the fuel amount already on the requested load - if it has been provided by the shipper. It is an alternative mechanism to SFTP, AS2, email, and on-screen lookups for obtaining fuel amounts for a load.
Setup
Enter Credentials
Enable the Breakthrough Fuel integration by:
Navigating to TMS Admin,
Select Credentials.
Select the Global Services tab,
Find Breakthrough in the list and open the card.
Check the Enabled box.
Enter the User ID and Password 1 into the text fields.
Click the Save button when finished.
Valid credentials are required from a Breakthrough Fuel subscription. See examples in the table below.
User ID | Password 1 | Password 2 | Customer Number |
|---|---|---|---|
Provided via BTF post-authorization document is received - example: revenova_customer_name | Provided via BTF post-authorization document is received - example: oR1444487X5Tj$nyQuV |
Remote Site Settings
Upgrading from previous versions of the TMS may have outdated information. Check that the Remote Site Settings for the Breakthrough Fuel integration URL are up to date.
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 find Breakthrough and click the Edit link.
Update the Remote Site URL to match the Service URL below:
Service URL: https://api.askfelix.com/
Text Service URL: https://api.testfelix.com/
Carrier Authorization Form
Complete the Carrier Authorization Form and send it to carriersupport@breakthroughfuel.com and ben.vandezande@breakthroughfuel.com. The authorization form with written consent is required from the Customer and the shippers they haul for. The BTF team can begin the work setting them up in our API and provide you the credentials. The first set of credentials is set for the ‘testing’ phase. Once testing is complete, the BTF team will provision another ‘production’ password that must be entered.
Breakthrough Fuel Surcharge Table
Create a Breakthrough Fuel Surcharge table from the TMS Admin → Fuel Surcharges link.
Click New Fuel Surcharge.
Enter the FSC table name, like “Breakthrough Fuel.”
From the Fuel Surcharge Source list, select Breakthrough Fuel.
Click Save.
Transportation Profile
Set the Breakthrough Fuel Shipper Id for each customer on their Transportation Profile. Note that the Breakthrough Fuel integration only functions for customer Transportation Profiles.
If the Shipper Id is invalid, an error message is displayed: Unauthorized.
Shipper is the Breakthrough Fuel Shipper Id that is set up in the Breakthrough system and entered on the Transportation Profile. The Shipment Number is the Customer Load Id from the Load record.
Warning
Do not allow spaces in the Breakthrough Fuel Shipper Id field. The following error message is displayed: "Your client has issued a malformed or illegal request." Example: https://api.askfelix.com/fuel-report/Dollar General.
Rate Entries
From TMS Admin → Rate Entries, create new rate entries. These rate entries should include Breakthrough FSC table or Fuel-Only Rate Entry.
Lane: US to US.
Fuel Surcharge: select the FS table created above.
Load
Set the Customer Load Id on the loads for that customer. Usually, this field is received - such as the PO Number - but is up to the customer on the load. The Customer Load Id field is the common identifier across all three parties for the load.
It is likely that a flow is necessary to insert the PO Number (or other load identifier) from the Load field into the Customer Load Id field.
If the Customer Load Id field is not populated, an error message with 'null' is displayed at the end of the URL. For example, https://api.askfelix.com/fuel-report/DollarGeneral/null.