This article will summarize the Breakthrough Fuel Integration
Summary
This integration allows us to efficiently access real-time fuel pricing data, which is crucial for managing transportation costs accurately. By leveraging Breakthrough Fuel's API, we can ensure that our pricing reflects current market conditions, thus providing our customers with the most competitive rates. The API connection facilitates seamless communication between our system and Breakthrough Fuel, enabling automated updates to the fuel prices associated with each shipment as their status changes. This integration not only enhances operational efficiency but also improves transparency in fuel pricing for our users.
Integration Source Setup
The integration has a few requirements to function appropriately.
Requirements:
- Source information:
- Username - Breakthrough Fuel API Username
- Password - Breakthrough Fuel API Password
- Source Settings:
- shipper (required) - Breakthrough Fuel's ShipperID
- referenceNumber (optional) - Tai Software's Reference Number Type
- If no Reference Number Type is specified, this will default to ShipmentID
- If the Reference Number Type specified doesn't have a value on the shipment, it will default to ShipmentID
- division (optional)
- This can be used for specific divisions that may have the same reference number
- test (optional)
- true - https://api.testfelix.com/fuel-report/
- false - https://api.askfelix.com/fuel-report/
Workflow
- When the Shipment Updates to In Transit or Delivered
- Tai will initiate an API Call to Breakthrough Fuel
- Breakthrough Fuel will provide a Sell Fuel Amount
- Tai will update the Sell Rate based on the amount provided
- Activity Logs will be added
- In Transit: "Breakthrough estimated fuel to be ${amount}. Fuel updated from ${original_fuel_amount} to ${amount}"
- Delivered: "Breakthrough final fuel set to ${amount}. Fuel updated from ${original_fuel_amount} to ${amount}"
- Activity Logs will be set to Private
- If Breakthrough is unable to locate a shipment match result, and error will occur
- Error: "Breakthrough was unable to locate a shipment match"
- Manual Trigger
- A button will be available to trigger the Fuel Update if needed manually
- This button will only be available for shipments In Transit up to Delivered Status