Overview
Banyan allows connection with and comparison of LTL carriers to find great shipping options at the optimal price for your load. Banyan Technology is a premier provider of live carrier and API connectivity for carrier management.
Easily connect with and compare LTL carriers to find great shipping options at the optimal price for your load. Banyan Technology is a premier provider of live carrier and API connectivity for carrier management.
Quote, tender, and track loads.
Document retrieval.
Used with the Customer Community for LTL quoting and tendering.
Setup
Enter Credentials
Enable the Banyan integration by:
Navigating to TMS Admin,
Select Credentials.
Select the Global Services tab,
Find Banyan in the list and open the card.
Check the Enabled, Shipper Rates, and Submit Pickup boxes.
If the customer is obtaining rates directly from the Carriers, Shipper Rates should be (true) "checked."
If expecting to retrieve 3PL rates through Banyan (e.g., Echo Global Logistics, Priority1), Shipper Rates should be (false) "unchecked."
Enter the User ID and Password 1 into the text fields.
Click the Save button when finished.
Valid credentials are required from a Banyan subscription. See examples in the table below.
User ID | Password 1 | Password 2 | Customer Number |
|---|---|---|---|
Required | Required |
ClienfRefNum = 18-character org Id
The TMS passes a ClientRefNum field to Banyan to determine which rates are used when quoting. This defaults to the 18-character org Id unless the Customer Transportation Profile’s Carrier API Login Group field is populated, in which case it uses that field.
The 18-character org Id and all other values need to be sent to the Banyan group.
To find the Org Id:
18-Character ORG Id: From Dev Console > Type “Select ID from Organization” within Query editor tab at the bottom > click Execute > Copy/paste the 18-character ORG Id.
Remote Site Settings
Upgrading from previous versions of the TMS may have outdated information. Check that the Remote Site Settings for the Banyan 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 Banyan and click the Edit link.
Update the Remote Site URL to match the Service URL below:
Service URL: https://ws.logistics.banyantechnology.com/services/api/rest
Test Service URL: https://ws.integration.banyantechnology.com/services/api/rest
Banyan-specific Carrier Services
The Carrier Service(s) and Rate Entries need to be created for LTL Banyan Carriers.
For the Carrier Service(s):
Set the Quote Method to API.
The API Provider must be set to Banyan.
The Credentials field is the Record Id of the Banyan credentials from TMS Admin → Credentials.
Review Carrier SCAC Codes
For each Carrier that the customer is requesting/obtaining quotes, the Transportation Profile SCAC field must be populated with a valid code. This is a unique two-to-four-letter code used to identify transportation companies.
SCAC code in Revenova and Banyan must match for Carrier Quotes to be created. If carrier quotes are available in the Banyan UI, but not in Revenova, enable Debug Logging and review the response packet.
The below are SCAC codes that may cause issues.
Carrier | TMS SCAC | Banyan SCAC |
|---|---|---|
XPO Logistics | XPOL | CNWY |
FAF, Inc. Class | FWDN | FWDA |
Initiate Batch Jobs
Run the LoadStatusUpdateJob to get load tracking updates from Banyan. There is no load specific status call for Banyan loads.
BanyanJob retrieves load documents (BOL and POD) from Delivered or Completed loads and any status available for active loads.
Additional accessorial charges and limited access accessorial charges may be added as they become available by adding API Accessorial records for Banyan.
Both Code and Subcode must be populated correctly for Banyan API Accessorial records.
SMC3 Quoting + Banyan Tender/Track/Images
Hybrid API Carrier Services that employ SMC3 for quoting and Banyan for tendering, tracking, and image retrieval may be used. These Carrier Services should be set up with the SMC3 RateWare Credentials Id.
Banyan Accessorial Subcodes
The Banyan API requires additional accessorial subcodes to correctly send information. The accessorial codes in the center column are provided by Banyan and subject to change. See Banyan API documentation for additional information.
Load Accessorials
Accessorial Name | Accessorial Code | Accessorial Subcode |
|---|---|---|
2nd Man | SMAN | SecondMan |
Blanket Service - Chilled | LBSCH | BlanketServiceChilled |
Blanket Service - Freeze Protection | LBSRV | BlanketService |
Blanket Service - Frozen | LBSFZ | BlanketServiceFrozen |
Blind Shipment | LBSHP | BlindShipment |
Bulkhead | BLKHD | Bulkhead |
Customs In-Bond | LBOND | CustomsInBond |
Expedited | LEXPD | Expedited |
Food Grade Products | LFGP | FoodGradeProducts |
Guaranteed | LGUAR | Guaranteed |
Holiday Delivery | LHDEL | HolidayDelivery |
Over Dimension | LODIM | OverDimension |
Proactive Response | PRORE | ProactiveResponse |
Restricted Delivery | RESDE | RestrictedDelivery |
Return Receipt | RETRE | ReturnReceipt |
Saturday Delivery | SATDE | SaturdayDelivery |
Shipment Hold | SHLD | ShipmentHold |
Shipper Release | SHIRE | ShipperRelease |
Signature Required | SIGRQ | SignatureRequired |
Single Shipment | LSING | SingleShipment |
Time Definite | LTIME | TimeDefinite |
TSA | LTS | TSA |
Turnkey | LTKEY | Turnkey |
Weight Determination | LWDET | WeightDetermination |
White Glove | WGLV | WhiteGlove |
Pickup Accessorials
Accessorial Name | Accessorial Code | Accessorial Subcode |
|---|---|---|
Inside Pickup | SIPCK | InsidePickup |
Liftgate Pickup | SLFTG | LiftgatePickup |
Marking and Tagging (Shipper) | SMARK | MarkingTagging |
Non-Business Hours Pickup | SNBP | NonBusinessHourPickup |
NYC Metro (Shipper) | SNYCM | NYCMetro |
Pallet Jack (Shipper) | SJACK | PalletJack |
Residential Pickup | SRPCK | ResidentialPickup |
Sort and Segregate (Shipper) | SSORT | SortSegregate |
Trade Show Pickup | LTPCK | TradeShowPickup |
Delivery Accessorials
Accessorial Name | Accessorial Code | Accessorial Subcode |
|---|---|---|
Delivery Notification | DELNO | DeliveryNotification |
Inside Delivery | CIDEL | InsideDelivery |
Liftgate Delivery | CLFTG | LiftgateDelivery |
Marking and Tagging (Consignee) | CMARK | MarkingTagging |
Non-Business Hours Delivery | CNBD | NonBusinessHourDelivery |
NYC Metro (Consignee) | CNYCM | NYCMetro |
Pallet Jack (Consignee) | CJACK | PalletJack |
Residential Delivery | CRDEL | ResidentialDelivery |
Sort and Segregate (Consignee) | CSORT | SortSegregate |
Trade Show Delivery | LTDEL | TradeShowDelivery |
Two Hour Special Delivery | THD | TwoHourSpecialDelivery |