Banyan

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.

The Banyan API provides the ability to:

• Quote, tender, and track LTL loads.

• Retrieve documents

• Quote and tender LTL loads with the Customer Community.

Setup

Enter Credentials

Enable the Banyan integration by completing the following steps.

1. Navigate to TMS Admin.

2. Select Credentials.

3. Choose the Global Services tab.

4. Find Banyan in the list and open the card.

5. Check the Enabled, Shipper Rates, and Submit Pickup boxes.

   1. If the customer is obtaining rates directly from the Carriers, Shipper Rates should be (true) Checked.

   2. If expecting to retrieve 3PL rates through Banyan (e.g., Echo Global Logistics, Priority1), Shipper Rates should be (false) Unchecked.

6. Enter the User ID and Password 1 into the text fields.

7. Note the Record Id field at the bottom of the card. This field is used for Banyan-specific Carrier Services.

8. Click the Save button when finished.

Valid credentials are required from a Banyan subscription. See examples in the table below.

TMS Admin

Set how often the TMS requests load tracking updates from Banyan. The TMS calls the Banyan endpoint for Load Tracking Updates and all active loads with status updates are returned to the TMS.

Configuration (Carrier Management / Automatic Load Status Updates fields)

Load Status Start Time: Set the time of day to begin receiving Banyan Load status updates.

Load Status Email Frequency (Hrs): Receive an email with load status updates.

Load Status API Frequency (Hrs): Set the interval period between calls to the Banyan API for load tracking updates.

Other Setup

The TMS passes a ClientRefNum field to Banyan to determine which rates are used when quoting. This defaults to the 18-character org Id.

ClientRefNum = 18-character org Id

If the Customer Transportation Profile’s Carrier API Login Group field is populated, the TMS uses that field instead.

Note: Before using the Banyan integration, the 18-character org Id and all other values need to be sent to the Banyan group.

To find the 18-character org Id:

1. Click the Setup icon.

2. Select Developer Console.

   

3. Type “Select ID from Organization” in the Query editor tab at the bottom.

4. Click Execute.

   

5. Copy 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.

1. Click the Setup gear icon in the top right corner.

2. From the drop-down, click Setup.

3. In the Quick Find Toolbar type Remote Site Settings and click the link.

4. From the list of remote sites find Banyan and click the Edit link.

5. 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 & Rate Entries

Carrier Service(s) and Rate Entries are required for LTL Banyan Carriers. Create a Carrier Service for each Carrier receiving quotes and tendering loads through Banyan.

See Carrier Service Setup for more specific instructions.

See Rate Entry Detail for more specific instructions for configuring rate entries.

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.

• The 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 table contains SCAC codes that may cause issues.

Initiate Batch Jobs

• Run the LoadStatusUpdateJob to get load tracking updates from Banyan. There is no Load-specific status call for Banyan Loads.

  Note: Load tracking status updates are NOT initiated by the Carrier Banner LWC. All load tracking status updates are completed with the Tracking Status Update API call based on the frequency settings.

• The BanyanJob retrieves load documents (BOL and POD) and any available status updates 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 the Code and Subcode fields must be populated correctly for Banyan API Accessorial records.

Ensure the LoadStatusUpdateJob is scheduled and/or running as intended to properly call and receive information from Banyan.

SMC3 Quoting + Banyan Tender/Track/Images

Hybrid API Carrier Services that use SMC3 for quoting and Banyan for tendering, tracking, and document retrieval may be used. These Carrier Services should be set up with the SMC3 RateWare Credentials Id.

See below for specific API information.

Integration Calls

Troubleshoot mismatched Carrier Quotes and Rate Entries with the following components.

• API Quote Audit Log (Quotes)

• Load Match Test (Rate Entries)

Load Quoting

When load rating begins, the TMS sends load information to the Banyan system to initiate the quote process. Quote requests are only sent to Carriers that accept the accessorial charges associated with the load. When the quote process completes, a response containing Carrier quotes is returned to the TMS.

Loads are rated when:

1. A user navigates to the Freight Quote Assistant for the first time.

2. A user refreshes quotes on the Carrier Quote Builder portion of the FQA.

3. A user clicks the Rerate action on the Customer Quote Builder portion of the FQA.

4. A user refreshes quotes on the Carrier Quote List LWC.

5. Users create loads with the Quote Wizard in the Customer Portal.

6. Creating loads with the LTL Pricing Workbench.

7. A new load is saved with the Save & Rate feature enabled.

When Save & Rate is enabled, loads are rated:

1. By clicking Save & Rate as part of new load creation.

2. When loads are cloned and Save & Rate is checked.

3. When inbound EDI 204 LTL load tenders are received.

Before the call is made, the TMS checks the customer Transportation Profile for any Carrier API Login Group information. If present, that value is included for any specific Carrier pricing for that customer.

Banyan Integration Notes

• Banyan considers COD and Declared Liability as accessorials.

• The Unit of Measure (SizeUOM) field is sent in the RateServices node.

• All dimension measurements are converted to inches prior to sending to Banyan.

• Handling Units are required to quote or tender through Banyan.

• Accessorials are matched against Code and Subcode before applying to any Carrier quotes.

• Carriers and Vendors are matched by SCAC when new quotes are received from Banyan.

• The QuoteID field is returned in the ImportForQuote_Sync call and is included in other calls to Banyan.

• Carrier quotes returned from Banyan contain the Interline parameter that populates the Carrier Quote Direct/Interline field. The Carrier Quote Direct/Interline field is set to either Direct or Interline based on the returned value. Control the Carrier quotes visible to Customer Portal users with the Portal Quote Direct/Interline Filter field on the Transportation Profile.

Loads sent to Banyan require several fields to successfully receive quotes. If these fields are not included on a load, the Banyan API is not called.

• NMFC Class

• Handling Units

• Shipping City, Shipping State, Shipping Postal Code

• Pickup Date

Notes

• The Banyan integration only supports 2 Stop Loads. If more than 2 Stop locations are included on a Load, no information returns.

• Banyan does not support the same location for Pickup and Delivery Stops. If the same location is used as a Pickup and Delivery, users receive an error.

Warning

Banyan load quoting does not support multiple line items if the packaging units differ. If attempting to quote a load with multiple line items, leave the Packaging Unit and PU Count fields blank.

Sample Send Load to Banyan Request Payload

{
  "AuthenticationData": {
    "Username": "Revenova",
    "Password": "Banyan",
    "ClientRefNum": "00D4z00000TP8ukMHD"
  },
  "Loadinfo": {},
  "BillTo": {
    "Name": "Revenova HQ",
    "ShipType": 0,
    "PayType": 1,
    "UseDefaultBillTo": true,
    "AddressInfo": {
      "Address1": "2333 Waukegan Rd.",
      "City": "Bannockburn",
      "CountryCode": "US",
      "State": "IL",
      "Zipcode": "60015",
      "LocationName": "Revenova HQ"
    },
    "ContactInfo": {},
    "UseDefaultShipType": false,
    "UseDefaultPayType": false
  },
  "RateServices": [
    {
      "ServiceCode": 1,
      "ShippingQty": 2,
      "PackageType": "29",
      "EquipmentType": "5"
    },
    {
      "ServiceCode": 2,
      "ShippingQty": 2,
      "PackageType": "29",
      "EquipmentType": "5"
    }
  ],
  "Shipper": {
    "ContactInfo": {
      "FirstName": "Joe",
      "LastName": "Banyan Customer",
      "ContactName": "Joe Banyan Customer",
      "Phone": "312-999-7777",
      "Fax": "312-222-3333",
      "Email": "testconsignee@revenova.com"
    },
    "AddressInfo": {
      "Address1": "2333 Waukegan Rd.",
      "Address2": "",
      "City": "Bannockburn",
      "CountryCode": "US",
      "State": "IL",
      "Zipcode": "60015",
      "LocationName": "Banyan Customer"
    },
    "CompanyName": "Banyan Customer",
    "LocationName": "Banyan Customer",
    "Dock": {
      "Name": "Dock",
      "Note": "Pickup Instructions",
      "OpenTime": "2024-07-26T09:00:00",
      "ShipmentDateTime": "2024-07-26T10:00:00",
      "CloseTime": "2024-07-26T22:00:00",
      "ConfirmationNumber": ""
    }
  },
  "Consignee": {
    "ContactInfo": {
      "FirstName": "Joe",
      "LastName": "Test",
      "ContactName": "Joe Test",
      "Phone": "312-999-7777",
      "Fax": "312-222-3333",
      "Email": "testconsignee@revenova.com"
    },
    "AddressInfo": {
      "Address1": "526 Beacon Street",
      "Address2": "",
      "City": "Boston",
      "CountryCode": "US",
      "State": "MA",
      "Zipcode": "02215",
      "LocationName": "Boston Beans"
    },
    "CompanyName": "Boston Beans",
    "LocationName": "Boston Beans",
    "Dock": {
      "Name": "Dock",
      "Note": "Delivery Instructions",
      "OpenTime": "2024-08-06T09:00:00",
      "ShipmentDateTime": "2024-08-06T10:00:00",
      "CloseTime": "2024-08-06T22:00:00",
      "ConfirmationNumber": ""
    }
  },
  "Products": [
    {
      "Quantity": 2,
      "PackageType": "29",
      "Weight": 1200,
      "Class": "9",
      "NMFC": "",
      "SKU": "Item 1",
      "IsHazmat": false,
      "Description": "Mixed",
      "Length": 48,
      "Width": 48,
      "Height": 48,
      "UOM": 0,
      "SortOrder": 1
    }
  ],
  "ShipperAccessorials": {
    "AppointmentRequired": false,
    "InsidePickup": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialPickup": false,
    "LiftgatePickup": false,
    "MarkingTagging": false,
    "TradeShowPickup": false,
    "NYCMetro": false,
    "NonBusinessHourPickup": false,
    "LimitedAccessType": "UNSPE"
  },
  "ConsigneeAccessorials": {
    "AppointmentRequired": false,
    "InsideDelivery": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialDelivery": false,
    "LiftgateDelivery": false,
    "MarkingTagging": false,
    "TradeShowDelivery": false,
    "NYCMetro": false,
    "DeliveryNotification": false,
    "TwoHourSpecialDelivery": false,
    "NonBusinessHourDelivery": false,
    "LimitedAccessType": "UNSPE"
  },
  "LoadAccessorials": {
    "Guaranteed": false,
    "TimeDefinite": false,
    "Expedited": false,
    "HolidayPickup": false,
    "HolidayDelivery": false,
    "WeightDetermination": false,
    "BlindShipment": false,
    "BlanketService": false,
    "SingleShipment": false,
    "CustomsInBond": false,
    "OverDimension": false,
    "Stackable": false,
    "Turnkey": false,
    "FoodGradeProducts": false,
    "TSA": false,
    "Bulkhead": false,
    "SignatureRequired": false,
    "BlanketServiceChilled": false,
    "BlanketServiceFrozen": false,
    "SaturdayDelivery": false,
    "SecondMan": false,
    "ReturnReceipt": false,
    "ShipmentHold": false,
    "ProactiveResponse": false,
    "ShipperRelease": false,
    "WhiteGlove": false,
    "RestrictedDelivery": false
  }
}

Sample Send Load to Banyan Response Payload

{
  "Load": {
    "AuthenticationData": {
      "Username": "_",
      "Password": "_",
      "ClientRefNum": "_"
    },
    "DebugMode": false,
    "Loadinfo": {
      "LoadID": 67488359,
      "ManifestID": "",
      "BOLNumber": "REV2420000003",
      "CustomerPO": "",
      "InvoiceID": "",
      "BillingID": "",
      "IncoTermID": null,
      "UltimateDestinationCountryCode": "",
      "PickupNumber": null,
      "EstimatedDeliveryDate": "0001-01-01T00:00:00",
      "EstimatedPickupDate": "0001-01-01T00:00:00",
      "ActualPickupDate": "0001-01-01T00:00:00",
      "ActualDeliveryDate": "0001-01-01T00:00:00"
    },
    "BillTo": {
      "Name": "Revenova",
      "Note": "",
      "ShipType": 0,
      "PayType": 1,
      "UseDefaultBillTo": true,
      "AddressInfo": {
        "Address1": "2333 Waukegan Rd",
        "Address2": "",
        "City": "Bannockburn",
        "CountryName": "United States",
        "CountryCode": "USA",
        "State": "IL",
        "Zipcode": "60015",
        "LocationName": "Revenova"
      },
      "ContactInfo": {
        "FirstName": "",
        "LastName": "",
        "ContactName": "",
        "Phone": "",
        "PhoneExt": "",
        "Fax": "",
        "Email": "noreply@revenova.com"
      },
      "UseDefaultShipType": false,
      "UseDefaultPayType": false
    },
    "InsuranceInfo": null,
    "RateServices": [
      {
        "ServiceCode": 1,
        "ShippingQty": 2,
        "PackageType": 29,
        "EquipmentType": 5,
        "AdditionalWeight": 0,
        "SpecialInstructions": "",
        "Length": null,
        "Width": null,
        "Height": null,
        "WeightUom": 1,
        "SizeUom": 1
      },
      {
        "ServiceCode": 2,
        "ShippingQty": 2,
        "PackageType": 29,
        "EquipmentType": 5,
        "AdditionalWeight": 0,
        "SpecialInstructions": "",
        "Length": null,
        "Width": null,
        "Height": null,
        "WeightUom": 1,
        "SizeUom": 1
      }
    ],
    "Shipper": {
      "ContactInfo": {
        "FirstName": "Joe",
        "LastName": "Banyan Customer",
        "ContactName": "Joe Banyan Customer",
        "Phone": "312-999-7777",
        "PhoneExt": "",
        "Fax": "312-222-3333",
        "Email": "testconsignee@revenova.com"
      },
      "AddressInfo": {
        "Address1": "2333 Waukegan Rd.",
        "Address2": "",
        "City": "Bannockburn",
        "CountryName": "United States",
        "CountryCode": "USA",
        "State": "IL",
        "Zipcode": "60015",
        "LocationName": "Banyan Customer"
      },
      "CompanyName": "Banyan Customer",
      "Note": "",
      "CompanyID": "",
      "LocationName": null,
      "VendorID": "",
      "DCRefNum": "",
      "Dock": {
        "Name": "Dock",
        "Note": "Pickup Instructions",
        "OpenTime": "2024-07-26T09:00:00",
        "ShipmentDateTime": "2024-07-26T10:00:00",
        "CloseTime": "2024-07-26T22:00:00",
        "ConfirmationNumber": "",
        "FCFS": false
      }
    },
    "Consignee": {
      "ContactInfo": {
        "FirstName": "Joe",
        "LastName": "Test",
        "ContactName": "Joe Test",
        "Phone": "312-999-7777",
        "PhoneExt": "",
        "Fax": "312-222-3333",
        "Email": "testconsignee@revenova.com"
      },
      "AddressInfo": {
        "Address1": "526 Beacon Street",
        "Address2": "",
        "City": "Boston",
        "CountryName": "United States",
        "CountryCode": "USA",
        "State": "MA",
        "Zipcode": "02215",
        "LocationName": "Boston Beans"
      },
      "CompanyName": "Boston Beans",
      "Note": "",
      "CompanyID": "",
      "LocationName": null,
      "VendorID": "",
      "DCRefNum": "",
      "Dock": {
        "Name": "Dock",
        "Note": "Delivery Instructions",
        "OpenTime": "2024-08-06T09:00:00",
        "ShipmentDateTime": "2024-08-06T10:00:00",
        "CloseTime": "2024-08-06T22:00:00",
        "ConfirmationNumber": "",
        "FCFS": false
      }
    },
    "ReturnLocation": null,
    "PackageInfo": {
      "CODAmount": 0,
      "DeclaredLiability": 0,
      "RouteNumber": ""
    },
    "Products": [
      {
        "Quantity": 2,
        "PackageType": 29,
        "Weight": 1200,
        "Class": 9,
        "NMFC": "",
        "SKU": "Item 1",
        "IsHazmat": false,
        "HazmatPhoneNumber": "",
        "HazmatPhoneExt": "",
        "Description": "Mixed",
        "Length": 48,
        "Width": 48,
        "Height": 48,
        "UOM": 0,
        "SortOrder": 1,
        "ReferenceNumber": "",
        "ParcelOptions": {
          "DeliveryConfirmation": 0,
          "COD": 0,
          "CODAmount": 0,
          "AdditionalHandling": false,
          "LargePackage": false,
          "DeclaredValue": 0,
          "UnitValue": null,
          "UnitWeight": null,
          "UnitType": null
        },
        "UnNumber": "",
        "HazMatShippingName": "",
        "HazMatPkgGroup": "",
        "HazMatClass": "",
        "InternationalOptions": {
          "ScheduleBCode": null,
          "HarmonizedSystemCode": null,
          "ECCN": null,
          "UnitOriginCountryCode": null
        },
        "HazMatContact": "",
        "HazMatPoison": false
      }
    ],
    "ShipperAccessorials": {
      "AppointmentRequired": false,
      "InsidePickup": false,
      "SortSegregate": false,
      "PalletJack": false,
      "ResidentialPickup": false,
      "LiftgatePickup": false,
      "MarkingTagging": false,
      "TradeShowPickup": false,
      "NYCMetro": false,
      "NonBusinessHourPickup": false,
      "LimitedAccessType": "Unspecified"
    },
    "ConsigneeAccessorials": {
      "AppointmentRequired": false,
      "InsideDelivery": false,
      "SortSegregate": false,
      "PalletJack": false,
      "ResidentialDelivery": false,
      "LiftgateDelivery": false,
      "MarkingTagging": false,
      "TradeShowDelivery": false,
      "NYCMetro": false,
      "DeliveryNotification": false,
      "TwoHourSpecialDelivery": false,
      "NonBusinessHourDelivery": false,
      "LimitedAccessType": "Unspecified"
    },
    "LoadAccessorials": {
      "Guaranteed": false,
      "TimeDefinite": false,
      "Expedited": false,
      "HolidayPickup": false,
      "HolidayDelivery": false,
      "WeightDetermination": false,
      "BlindShipment": false,
      "BlanketService": false,
      "ProtectFromFreezing": false,
      "SingleShipment": false,
      "CustomsInBond": false,
      "OverDimension": false,
      "Stackable": false,
      "Turnkey": false,
      "FoodGradeProducts": false,
      "TSA": false,
      "Bulkhead": false,
      "SignatureRequired": false,
      "BlanketServiceChilled": false,
      "BlanketServiceFrozen": false,
      "SaturdayDelivery": false,
      "SecondMan": false,
      "ReturnReceipt": false,
      "ShipmentHold": false,
      "ProactiveResponse": false,
      "ShipperRelease": false,
      "WhiteGlove": false,
      "RestrictedDelivery": false,
      "TankerEndorsedDriverRequired": false
    },
    "UserDefined": [],
    "ReferenceField": []
  },
  "Quotes": [
    {
      "LoadID": 67488359,
      "QuoteID": 521310086,
      "CarrierName": "Dayton Freight Standard",
      "SCAC": "DAFG",
      "ThirdPartyName": "",
      "ThirdPartySCAC": "",
      "ServiceID": "73121597",
      "RawPrice": {
        "NetPrice": 501.44,
        "FreightCharge": 218.64,
        "DiscountAmount": 556.68,
        "FuelSurcharge": 32.8,
        "Minimum": 0,
        "GrossCharge": 775.32,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 250,
        "Charges": [
          {
            "Name": "Limited Access Delivery Charge",
            "Amount": 125,
            "Code": "SLAD"
          },
          {
            "Name": "Limited Access Pickup Charge",
            "Amount": 125,
            "Code": "SLAP"
          }
        ],
        "Markup": 0
      },
      "CarrierPrice": {
        "NetPrice": 501.44,
        "FreightCharge": 218.64,
        "DiscountAmount": 556.68,
        "FuelSurcharge": 32.8,
        "Minimum": 0,
        "GrossCharge": 775.32,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 250,
        "Charges": [
          {
            "Name": "Limited Access Delivery Charge",
            "Amount": 125,
            "Code": "SLAD"
          },
          {
            "Name": "Limited Access Pickup Charge",
            "Amount": 125,
            "Code": "SLAP"
          }
        ],
        "Markup": 0
      },
      "CustomerPrice": {
        "NetPrice": 501.44,
        "FreightCharge": 218.64,
        "DiscountAmount": 556.68,
        "FuelSurcharge": 32.8,
        "Minimum": 0,
        "GrossCharge": 775.32,
        "Tariff": 0,
        "Interline": 0,
        "AccessorialCharges": 0,
        "OtherCharges": 250,
        "Charges": [
          {
            "Name": "Limited Access Delivery Charge",
            "Amount": 125,
            "Code": "SLAD"
          },
          {
            "Name": "Limited Access Pickup Charge",
            "Amount": 125,
            "Code": "SLAP"
          }
        ],
        "Markup": 0
      },
      "TransitTime": 1,
      "QuoteNumber": "122805585",
      "CarrierPerson": "Dayton Freight Automated Quote",
      "CarrierNote": "",
      "Datestamp": "2024-07-18T15:13:55",
      "Interline": false,
      "Accepted": false,
      "CurrencyType": 0,
      "Service": 1,
      "InsuranceDetails": null,
      "AccountNumber": "6629252"
    }
  ],
  "PendingQuotes": null,
  "FailedQuotes": [
    {
      "CarrierName": "Banyan Test Carrier",
      "SCAC": "BTST",
      "Service": 1,
      "ReasonCode": 32,
      "Reason": "Shipment contains a limited access requirement that is not supported by the carrier.",
      "Datestamp": "2024-07-18T19:13:56.913"
    },
    {
      "CarrierName": "BanyanTest3PL",
      "SCAC": "BTPL",
      "Service": 1,
      "ReasonCode": 32,
      "Reason": "Shipment contains a limited access requirement that is not supported by the carrier.",
      "Datestamp": "2024-07-18T19:13:55.533"
    },
  ],
  "Notes": [
    {
      "Text": "Banyan Test Carrier did not rate. This shipment contains limited access requirements not supported by the carrier's rate engine.",
      "User": "Automation",
      "DateStamp": "2024-07-18T15:13:56",
      "NoteType": 15
    },
    {
      "Text": "Banyan Test Carrier: Please contact your service provider for a LTL quote.",
      "User": "Automation",
      "DateStamp": "2024-07-18T15:13:56",
      "NoteType": 15
    },
    {
      "Text": "BanyanTest3PL: Please contact your service provider for a LTL quote.",
      "User": "Automation",
      "DateStamp": "2024-07-18T15:13:55",
      "NoteType": 15
    },
    {
      "Text": "Load Created",
      "User": "Revenova Web Services",
      "DateStamp": "2024-07-18T15:13:51",
      "NoteType": 10
    }
  ],
  "RatingComplete": true,
  "ErrorMessage": null
}

TMS Field Updates

See Banyan documentation here.

Update Loads

If load information changes, the UpdateLoad endpoint is called to update the load in the Banyan system. An additional NeedsReRated Boolean and any Messages return to the TMS with a list of Carrier quotes. This call is similar to the ImportForQuote_Sync call.

If load information changed and was successfully rerated, an exception prevents the user from rerating a load. Load information must change to allow for rerating.

Changes to any of the following fields allows for a rerate.

• ClientRefNum (The Organization Id or the Carrier API Login Group from the customer Transportation Profile)

• Insurance information.

• Shipper Address fields, Pickup Time, or Vendor ID.

• Consignee Address fields or VendorID.

• Product information including Dimensions, Quantity, Weight, Package Type, Freight class, or Hazmat.

• Adding or removing products.

• Rate Services information including Dimensions, Quantity, Package Type, Service Type, or Weight.

• Package Information including Declared Liability or COD Amount.

• Adding or removing Pickup, Delivery, or Load Accessorials.

Sample Send Load Updates to Banyan Request

({
  "AuthenticationData": {
    "Username": "",
    "Password": "",
    "ClientRefNum": ""
  },
  "Loadinfo": {
    "LoadID": "",
    "InvoiceID": ""
  },
  "BillTo": {
    "Name": "",
    "Note": "",
    "ShipType": 1,
    "PayType": 1,
    "UseDefaultBillTo": false,
    "AddressInfo": {
      "Address1": "123245 Test St.",
      "Address2": "",
      "City": "North Ridgeville",
      "CountryName": null,
      "CountryCode": "",
      "State": "OH",
      "Zipcode": "44039",
      "LocationName": "Test"
    },
    "ContactInfo": {
      "FirstName": "",
      "LastName": "",
      "ContactName": "",
      "Phone": "",
      "PhoneExt": "",
      "Fax": "",
      "Email": ""
    }
  },
  "InsuranceInfo": null,
  "RateServices": [
    {
      "ServiceCode": 1,
      "ShippingQty": 3,
      "PackageType": 29,
      "EquipmentType": 5,
      "AdditionalWeight": 50,
      "SpecialInstructions": "Do not break",
      "Length": null,
      "Width": null,
      "Height": null,
      "WeightUom": 1,
      "SizeUom": 1
    }
    {
      "ServiceCode": 2,
      "ShippingQty": 3,
      "PackageType": 29,
      "EquipmentType": 5,
      "AdditionalWeight": 50,
      "SpecialInstructions": "Do not break",
      "Length": null,
      "Width": null,
      "Height": null,
      "WeightUom": 1,
      "SizeUom": 1
    }
  ],
  "Shipper": {
    "ContactInfo": {
      "FirstName": "User",
      "LastName": "User",
      "ContactName": "User",
      "Phone": "3211231234",
      "PhoneExt": "",
      "Fax": "",
      "Email": "test@test.com"
    },
    "AddressInfo": {
      "Address1": "123245 Test St.",
      "Address2": "",
      "City": "South Bend",
      "CountryName": null,
      "CountryCode": "",
      "State": "IN",
      "Zipcode": "46628",
      "LocationName": "Test"
    },
    "CompanyName": "",
    "Note": "",
    "CompanyID": "",
    "LocationName": null,
    "VendorID": null,
    "DCRefNum": null,
    "Dock": {
      "Name": "Main Dock",
      "Note": "",
      "OpenTime": "2018-04-27T08:00:00",
      "ShipmentDateTime": "2018-04-27T12:00:00",
      "CloseTime": "2018-04-27T17:00:00",
      "ConfirmationNumber": "",
      "FCFS": true
    }
  },
  "Consignee": {
    "ContactInfo": {
      "FirstName": "",
      "LastName": "",
      "ContactName": "",
      "Phone": "",
      "PhoneExt": "",
      "Fax": "",
      "Email": ""
    },
    "AddressInfo": {
      "Address1": "54321 Test Blvd.",
      "Address2": "",
      "City": "Foley",
      "CountryName": null,
      "CountryCode": "",
      "State": "AL",
      "Zipcode": "36535",
      "LocationName": "Test"
    },
    "CompanyName": "",
    "Note": "",
    "CompanyID": "",
    "LocationName": null,
    "VendorID": null,
    "DCRefNum": null,
    "Dock": {
      "Name": "Main Dock",
      "Note": "",
      "OpenTime": "2018-07-11T08:00:00",
      "ShipmentDateTime": "2018-07-11T12:00:00",
      "CloseTime": "2018-07-11T17:00:00",
      "ConfirmationNumber": "",
      "FCFS": true
    }
  },
  "PackageInfo": {
    "CODAmount": 0,
    "DeclaredLiability": 0
  },
  "Products": [
    {
      "Quantity": 3,
      "PackageType": 29,
      "Weight": 1200,
      "Class": 9,
      "NMFC": "",
      "SKU": "",
      "IsHazmat": false,
      "HazmatPhoneNumber": "",
      "HazmatPhoneExt": "",
      "Description": "Testing",
      "Length": 48,
      "Width": 48,
      "Height": 24,
      "UOM": 0,
      "SortOrder": 1,
      "ReferenceNumber": "",
      "ParcelOptions": {
        "DeliveryConfirmation": 0,
        "COD": 0,
        "CODAmount": 0,
        "AdditionalHandling": false,
        "LargePackage": false,
        "DeclaredValue": 0
      }
    }
  ],
  "ShipperAccessorials": {
    "AppointmentRequired": false,
    "InsidePickup": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialPickup": false,
    "LiftgatePickup": false,
    "MarkingTagging": false,
    "TradeShowPickup": false,
    "NYCMetro": false,
    "NonBusinessHourPickup": false,
    "LimitedAccessType": null
  },
  "ConsigneeAccessorials": {
    "AppointmentRequired": false,
    "InsideDelivery": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialDelivery": false,
    "LiftgateDelivery": false,
    "MarkingTagging": false,
    "TradeShowDelivery": false,
    "NYCMetro": false,
    "DeliveryNotification": false,
    "TwoHourSpecialDelivery": false,
    "NonBusinessHourDelivery": false,
    "LimitedAccessType": null
  },
  "LoadAccessorials": {
    "Guaranteed": false,
    "TimeDefinite": false,
    "Expedited": false,
    "HolidayPickup": false,
    "HolidayDelivery": false,
    "WeightDetermination": false,
    "BlindShipment": false,
    "BlanketService": false,
    "SingleShipment": false,
    "CustomsInBond": false,
    "OverDimension": false,
    "Stackable": false,
    "Turnkey": false,
    "FoodGradeProducts": false,
    "TSA": false,
    "Bulkhead": false,
    "SignatureRequired": false,
    "BlanketServiceChilled": false,
    "BlanketServiceFrozen": false,
    "SaturdayDelivery": false,
    "SecondMan": false,
    "ReturnReceipt": false,
    "ShipmentHold": false,
    "ProactiveResponse": false,
    "ShipperRelease": false,
    "WhiteGlove": false,
    "RestrictedDelivery": false
  }
});

Sample Send Load Updates to Banyan Response

{
  "Success": true,
  "NeedsReRated": false,
  "ReRateReason": "Vital information has been updated: The shipper's city changed from NORTH RIDGEVILLE to SOUTH BEND. The shipper's state changed from OH to IN. The shipper's zip code changed from 44039 to 46628. The consignee's city changed from CHICAGO to FOLEY. The consignee's state changed from IL to AL. The consignee's zip code changed from 60606 to 36535. Product 1's weight changed from 2500 to 1200. Service 1 package type changed from PAIL to . ",
  "RatingComplete": true,
  "Load": {
    "AuthenticationData": {
      "Username": "_",
      "Password": "_",
      "ClientRefNum": "_"
    },
    "Loadinfo": {
      "LoadID": 13624203,
      "ManifestID": null,
      "BOLNumber": "180724",
      "CustomerPO": "",
      "InvoiceID": "",
      "BillingID": "",
      "IncoTermID": null
    },
    "BillTo": {
      "Name": "",
      "Note": "",
      "ShipType": 1,
      "PayType": 1,
      "UseDefaultBillTo": false,
      "AddressInfo": {
        "Address1": "123245 Test St.",
        "Address2": "",
        "City": "North Ridgeville",
        "CountryName": null,
        "CountryCode": "",
        "State": "OH",
        "Zipcode": "44039",
        "LocationName": "Test"
      },
      "ContactInfo": {
        "FirstName": "",
        "LastName": "",
        "ContactName": "",
        "Phone": "",
        "PhoneExt": "",
        "Fax": "",
        "Email": ""
      }
    },
    "InsuranceInfo": null,
    "RateServices": [
      {
        "ServiceCode": 1,
        "ShippingQty": 3,
        "PackageType": 29,
        "EquipmentType": 5,
        "AdditionalWeight": 50,
        "SpecialInstructions": "Do not break",
        "Length": null,
        "Width": null,
        "Height": null,
        "WeightUom": 1,
        "SizeUom": 1
      }
    ],
    "Shipper": {
      "ContactInfo": {
        "FirstName": "User",
        "LastName": "User",
        "ContactName": "User",
        "Phone": "3211231234",
        "PhoneExt": "",
        "Fax": "",
        "Email": "test@test.com"
      },
      "AddressInfo": {
        "Address1": "123245 Test St.",
        "Address2": "",
        "City": "South Bend",
        "CountryName": null,
        "CountryCode": "",
        "State": "IN",
        "Zipcode": "46628",
        "LocationName": "Test"
      },
      "CompanyName": "",
      "Note": "",
      "CompanyID": "",
      "LocationName": null,
      "VendorID": null,
      "DCRefNum": null,
      "Dock": {
        "Name": "Main Dock",
        "Note": "",
        "OpenTime": "2018-04-27T08:00:00",
        "ShipmentDateTime": "2018-04-27T12:00:00",
        "CloseTime": "2018-04-27T17:00:00",
        "ConfirmationNumber": "",
        "FCFS": true
      }
    },
    "Consignee": {
      "ContactInfo": {
        "FirstName": "",
        "LastName": "",
        "ContactName": "",
        "Phone": "",
        "PhoneExt": "",
        "Fax": "",
        "Email": ""
      },
      "AddressInfo": {
        "Address1": "54321 Test Blvd.",
        "Address2": "",
        "City": "Foley",
        "CountryName": null,
        "CountryCode": "",
        "State": "AL",
        "Zipcode": "36535",
        "LocationName": "Test"
      },
      "CompanyName": "",
      "Note": "",
      "CompanyID": "",
      "LocationName": null,
      "VendorID": null,
      "DCRefNum": null,
      "Dock": {
        "Name": "Main Dock",
        "Note": "",
        "OpenTime": "2018-07-11T08:00:00",
        "ShipmentDateTime": "2018-07-11T12:00:00",
        "CloseTime": "2018-07-11T17:00:00",
        "ConfirmationNumber": "",
        "FCFS": true
      }
    },
    "PackageInfo": {
      "CODAmount": 0,
      "DeclaredLiability": 0
    },
    "Products": [
      {
        "Quantity": 3,
        "PackageType": 29,
        "Weight": 1200,
        "Class": 9,
        "NMFC": "",
        "SKU": "",
        "IsHazmat": false,
        "HazmatPhoneNumber": "",
        "HazmatPhoneExt": "",
        "Description": "Testing",
        "Length": 48,
        "Width": 48,
        "Height": 24,
        "UOM": 0,
        "SortOrder": 1,
        "ReferenceNumber": "",
        "ParcelOptions": {
          "DeliveryConfirmation": 0,
          "COD": 0,
          "CODAmount": 0,
          "AdditionalHandling": false,
          "LargePackage": false,
          "DeclaredValue": 0
        }
      }
    ],
    "ShipperAccessorials": {
      "AppointmentRequired": false,
      "InsidePickup": false,
      "SortSegregate": false,
      "PalletJack": false,
      "ResidentialPickup": false,
      "LiftgatePickup": false,
      "MarkingTagging": false,
      "TradeShowPickup": false,
      "NYCMetro": false,
      "NonBusinessHourPickup": false,
      "LimitedAccessType": null
    },
    "ConsigneeAccessorials": {
      "AppointmentRequired": false,
      "InsideDelivery": false,
      "SortSegregate": false,
      "PalletJack": false,
      "ResidentialDelivery": false,
      "LiftgateDelivery": false,
      "MarkingTagging": false,
      "TradeShowDelivery": false,
      "NYCMetro": false,
      "DeliveryNotification": false,
      "TwoHourSpecialDelivery": false,
      "NonBusinessHourDelivery": false,
      "LimitedAccessType": null
    },
    "LoadAccessorials": {
      "Guaranteed": false,
      "TimeDefinite": false,
      "Expedited": false,
      "HolidayPickup": false,
      "HolidayDelivery": false,
      "WeightDetermination": false,
      "BlindShipment": false,
      "BlanketService": false,
      "SingleShipment": false,
      "CustomsInBond": false,
      "OverDimension": false,
      "Stackable": false,
      "Turnkey": false,
      "FoodGradeProducts": false,
      "TSA": false,
      "Bulkhead": false,
      "SignatureRequired": false,
      "BlanketServiceChilled": false,
      "BlanketServiceFrozen": false,
      "SaturdayDelivery": false,
      "SecondMan": false,
      "ReturnReceipt": false,
      "ShipmentHold": false,
      "ProactiveResponse": false,
      "ShipperRelease": false,
      "WhiteGlove": false,
      "RestrictedDelivery": false
    },
    "UserDefined": [],
    "ReferenceField": []
  },
  "Quotes": null,
  "Notes": [
    {
      "Text": "UpdateLoad ImportID: 21773374",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:17:06"
    },
    {
      "Text": "Load has been updated using the update load web method.",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:17:06"
    },
    {
      "Text": "Load was moved into cancelled status with the web service function CancelLoad.",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:06:39"
    },
    {
      "Text": "Status changed from Quoted to Cancelled.",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:06:39"
    },
    {
      "Text": "Load Was UnBooked. Original Pro Number assigned -  - has been deleted.",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:04:00"
    },
    {
      "Text": "LoadID:13624203BolNum:180724QuoteID:131097567ManifestID:ActualCharge:489.24PickupDate:8/12/2018AccessTime:12:00CarrierID:7671Web_Dispatch:FalseEDI_Dispatch:False",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:01:42"
    },
    {
      "Text": "The user declined to send a pick-up request for this shipment by unchecking the Submit Pickup Request box.",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:01:42"
    },
    {
      "Text": "<a href=javascript:ShowTerminalLink('7671','13624203')>Terminal Link</a>",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:01:42"
    },
    {
      "Text": "Load booked with R L Carriers.",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:01:42"
    },
    {
      "Text": "Awarded quote email was not sent due to permissions.",
      "User": "Mike Jones",
      "DateStamp": "2018-08-12T16:01:42"
    },
    {
      "Text": "Original shipperDateTime = 08/12/2018Original consigneedatetime = 04/27/2018New shipperDateTime = 08/12/2018New consigneedatetime = 08/15/2018ActualPickupDate = 08/12/2018ActualDeliverDate = 08/15/2018",
      "User": "Automation",
      "DateStamp": "2018-08-12T16:01:42"
    },
    {
      "Text": "Override for 781629580 - <br />- Default Ship<br />- Billing",
      "User": "Automation",
      "DateStamp": "2018-07-17T07:39:38"
    },
    {
      "Text": "Trucking Company 1: Pickup Date cannot be less than Current Date. Please double check Pickup Date.",
      "User": "Automation",
      "DateStamp": "2018-07-17T07:39:36"
    }
  ],
  "Error": null
}

TMS Field Updates

See Banyan documentation here.

Tender a Load

Once a quote is selected, the load may be tendered to the Carrier with a call to the Banyan BookLoad endpoint. A request to dispatch the load is also sent with this call.

In order to successfully make this call, the QuoteID field is required. This field is returned from Banyan during Load Quoting.

The SubmitPickup bit controls the communication to the Carrier on a successful load tender.

Sample Send Tender Load to Banyan Request Payload

{
  "AuthenticationData": {
    "Username": "Revenova",
    "Password": "Test123",
    "ClientRefNum": "00D7zukEAD"
  },
  "Loadinfo": {
    "LoadID": "67488359",
    "BOLNumber": "730759460"
  },
  "BillTo": {
    "Name": "Revenova HQ",
    "ShipType": 0,
    "PayType": 1,
    "UseDefaultBillTo": true,
    "AddressInfo": {
      "Address1": "2333 Waukegan Rd.",
      "City": "Bannockburn",
      "CountryCode": "US",
      "State": "IL",
      "Zipcode": "60015",
      "LocationName": "Revenova HQ"
    },
    "ContactInfo": {},
    "UseDefaultShipType": false,
    "UseDefaultPayType": false
  },
  "RateServices": [
    {
      "ServiceCode": 1,
      "ShippingQty": 2,
      "PackageType": "29",
      "EquipmentType": "5"
    },
    {
      "ServiceCode": 2,
      "ShippingQty": 2,
      "PackageType": "29",
      "EquipmentType": "5"
    }
  ],
  "Shipper": {
    "ContactInfo": {
      "FirstName": "Joe",
      "LastName": "Banyan Customer",
      "ContactName": "Joe Banyan Customer",
      "Phone": "312-999-7777",
      "Fax": "312-222-3333",
      "Email": "test@revenova.com"
    },
    "AddressInfo": {
      "Address1": "2333 Waukegan Rd.",
      "Address2": "",
      "City": "Bannockburn",
      "CountryCode": "US",
      "State": "IL",
      "Zipcode": "60015",
      "LocationName": "Banyan Customer"
    },
    "CompanyName": "Banyan Customer",
    "LocationName": "Banyan Customer",
    "Dock": {
      "Name": "Dock",
      "Note": "Pickup Instructions",
      "OpenTime": "2024-07-26T09:00:00",
      "ShipmentDateTime": "2024-07-26T10:00:00",
      "CloseTime": "2024-07-26T22:00:00",
      "ConfirmationNumber": ""
    }
  },
  "Consignee": {
    "ContactInfo": {
      "FirstName": "Joe",
      "LastName": "Test Company",
      "ContactName": "Joe Test Company",
      "Phone": "312-999-7777",
      "Fax": "312-222-3333",
      "Email": "test@revenova.com"
    },
    "AddressInfo": {
      "Address1": "2333 Waukegan Rd.",
      "Address2": "",
      "City": "Chicago",
      "CountryCode": "US",
      "State": "IL",
      "Zipcode": "60602",
      "LocationName": "Revenova HQ"
    },
    "CompanyName": "Revenova HQ",
    "LocationName": "Revenova HQ",
    "Dock": {
      "Name": "Dock",
      "Note": "Delivery Instructions",
      "OpenTime": "2024-08-06T09:00:00",
      "ShipmentDateTime": "2024-08-06T10:00:00",
      "CloseTime": "2024-08-06T22:00:00",
      "ConfirmationNumber": ""
    }
  },
  "Products": [
    {
      "Quantity": 2,
      "PackageType": "29",
      "Weight": 1200,
      "Class": "9",
      "NMFC": "",
      "SKU": "Item 1",
      "IsHazmat": false,
      "Description": "Mixed",
      "Length": 48,
      "Width": 48,
      "Height": 48,
      "UOM": 0,
      "SortOrder": 1
    }
  ],
  "ShipperAccessorials": {
    "AppointmentRequired": false,
    "InsidePickup": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialPickup": false,
    "LiftgatePickup": false,
    "MarkingTagging": false,
    "TradeShowPickup": false,
    "NYCMetro": false,
    "NonBusinessHourPickup": false,
    "LimitedAccessType": "UNSPE"
  },
  "ConsigneeAccessorials": {
    "AppointmentRequired": false,
    "InsideDelivery": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialDelivery": false,
    "LiftgateDelivery": false,
    "MarkingTagging": false,
    "TradeShowDelivery": false,
    "NYCMetro": false,
    "DeliveryNotification": false,
    "TwoHourSpecialDelivery": false,
    "NonBusinessHourDelivery": false,
    "LimitedAccessType": "UNSPE"
  },
  "LoadAccessorials": {
    "Guaranteed": false,
    "TimeDefinite": false,
    "Expedited": false,
    "HolidayPickup": false,
    "HolidayDelivery": false,
    "WeightDetermination": false,
    "BlindShipment": false,
    "BlanketService": false,
    "SingleShipment": false,
    "CustomsInBond": false,
    "OverDimension": false,
    "Stackable": false,
    "Turnkey": false,
    "FoodGradeProducts": false,
    "TSA": false,
    "Bulkhead": false,
    "SignatureRequired": false,
    "BlanketServiceChilled": false,
    "BlanketServiceFrozen": false,
    "SaturdayDelivery": false,
    "SecondMan": false,
    "ReturnReceipt": false,
    "ShipmentHold": false,
    "ProactiveResponse": false,
    "ShipperRelease": false,
    "WhiteGlove": false,
    "RestrictedDelivery": false
  }
}

Sample Send Tender Load to Banyan Response Payload

{
  "Success": true,
  "NeedsReRated": false,
  "ReRateReason": null,
  "RatingComplete": true,
  "Load": {
    "AuthenticationData": {
      "Username": "_",
      "Password": "_",
      "ClientRefNum": "_"
    },
    "DebugMode": false,
    "Loadinfo": {
      "LoadID": 67488359,
      "ManifestID": "",
      "BOLNumber": "730759460",
      "CustomerPO": "",
      "InvoiceID": "",
      "BillingID": "",
      "IncoTermID": null,
      "UltimateDestinationCountryCode": "",
      "PickupNumber": null,
      "EstimatedDeliveryDate": "0001-01-01T00:00:00",
      "EstimatedPickupDate": "0001-01-01T00:00:00",
      "ActualPickupDate": "0001-01-01T00:00:00",
      "ActualDeliveryDate": "0001-01-01T00:00:00"
    },
    "BillTo": {
      "Name": "Revenova",
      "Note": "",
      "ShipType": 0,
      "PayType": 1,
      "UseDefaultBillTo": true,
      "AddressInfo": {
        "Address1": "2333 Waukegan Rd",
        "Address2": "",
        "City": "Bannockburn",
        "CountryName": "United States",
        "CountryCode": "USA",
        "State": "IL",
        "Zipcode": "60015",
        "LocationName": "Revenova"
      },
      "ContactInfo": {
        "FirstName": "",
        "LastName": "",
        "ContactName": "",
        "Phone": "",
        "PhoneExt": "",
        "Fax": "",
        "Email": "noreply@revenova.com"
      },
      "UseDefaultShipType": false,
      "UseDefaultPayType": false
    },
    "InsuranceInfo": null,
    "RateServices": [
      {
        "ServiceCode": 1,
        "ShippingQty": 2,
        "PackageType": 29,
        "EquipmentType": 5,
        "AdditionalWeight": 0,
        "SpecialInstructions": "",
        "Length": null,
        "Width": null,
        "Height": null,
        "WeightUom": 1,
        "SizeUom": 1
      },
      {
        "ServiceCode": 2,
        "ShippingQty": 2,
        "PackageType": 29,
        "EquipmentType": 5,
        "AdditionalWeight": 0,
        "SpecialInstructions": "",
        "Length": null,
        "Width": null,
        "Height": null,
        "WeightUom": 1,
        "SizeUom": 1
      }
    ],
    "Shipper": {
      "ContactInfo": {
        "FirstName": "Joe",
        "LastName": "Banyan Customer",
        "ContactName": "Joe Banyan Customer",
        "Phone": "312-999-7777",
        "PhoneExt": "",
        "Fax": "312-222-3333",
        "Email": "test@revenova.com"
      },
      "AddressInfo": {
        "Address1": "2333 Waukegan Rd.",
        "Address2": "",
        "City": "Bannockburn",
        "CountryName": "United States",
        "CountryCode": "USA",
        "State": "IL",
        "Zipcode": "60015",
        "LocationName": "Banyan Customer"
      },
      "CompanyName": "Banyan Customer",
      "Note": "",
      "CompanyID": "",
      "LocationName": null,
      "VendorID": "",
      "DCRefNum": "",
      "Dock": {
        "Name": "Dock",
        "Note": "Pickup Instructions",
        "OpenTime": "2024-07-26T09:00:00",
        "ShipmentDateTime": "2024-07-26T10:00:00",
        "CloseTime": "2024-07-26T22:00:00",
        "ConfirmationNumber": "",
        "FCFS": false
      }
    },
    "Consignee": {
      "ContactInfo": {
        "FirstName": "Joe",
        "LastName": "Test Customer",
        "ContactName": "Joe Test Customer",
        "Phone": "312-999-7777",
        "PhoneExt": "",
        "Fax": "312-222-3333",
        "Email": "test@revenova.com"
      },
      "AddressInfo": {
        "Address1": "Revenova HQ",
        "Address2": "",
        "City": "Bannockburn",
        "CountryName": "United States",
        "CountryCode": "USA",
        "State": "IL",
        "Zipcode": "60015",
        "LocationName": "Revenova HQ"
      },
      "CompanyName": "Revenova HQ",
      "Note": "",
      "CompanyID": "",
      "LocationName": null,
      "VendorID": "",
      "DCRefNum": "",
      "Dock": {
        "Name": "Dock",
        "Note": "Delivery Instructions",
        "OpenTime": "2024-08-06T09:00:00",
        "ShipmentDateTime": "2024-08-06T10:00:00",
        "CloseTime": "2024-08-06T22:00:00",
        "ConfirmationNumber": "",
        "FCFS": false
      }
    },
    "ReturnLocation": null,
    "PackageInfo": {
      "CODAmount": 0,
      "DeclaredLiability": 0,
      "RouteNumber": ""
    },
    "Products": [
      {
        "Quantity": 2,
        "PackageType": 29,
        "Weight": 1200,
        "Class": 9,
        "NMFC": "",
        "SKU": "Item 1",
        "IsHazmat": false,
        "HazmatPhoneNumber": "",
        "HazmatPhoneExt": "",
        "Description": "Mixed",
        "Length": 48,
        "Width": 48,
        "Height": 48,
        "UOM": 0,
        "SortOrder": 1,
        "ReferenceNumber": "",
        "ParcelOptions": {
          "DeliveryConfirmation": 0,
          "COD": 0,
          "CODAmount": 0,
          "AdditionalHandling": false,
          "LargePackage": false,
          "DeclaredValue": 0,
          "UnitValue": null,
          "UnitWeight": null,
          "UnitType": null
        },
        "UnNumber": "",
        "HazMatShippingName": "",
        "HazMatPkgGroup": "",
        "HazMatClass": "",
        "InternationalOptions": {
          "ScheduleBCode": null,
          "HarmonizedSystemCode": null,
          "ECCN": null,
          "UnitOriginCountryCode": null
        },
        "HazMatContact": "",
        "HazMatPoison": false
      }
    ],
    "ShipperAccessorials": {
      "AppointmentRequired": false,
      "InsidePickup": false,
      "SortSegregate": false,
      "PalletJack": false,
      "ResidentialPickup": false,
      "LiftgatePickup": false,
      "MarkingTagging": false,
      "TradeShowPickup": false,
      "NYCMetro": false,
      "NonBusinessHourPickup": false,
      "LimitedAccessType": "Unspecified"
    },
    "ConsigneeAccessorials": {
      "AppointmentRequired": false,
      "InsideDelivery": false,
      "SortSegregate": false,
      "PalletJack": false,
      "ResidentialDelivery": false,
      "LiftgateDelivery": false,
      "MarkingTagging": false,
      "TradeShowDelivery": false,
      "NYCMetro": false,
      "DeliveryNotification": false,
      "TwoHourSpecialDelivery": false,
      "NonBusinessHourDelivery": false,
      "LimitedAccessType": "Unspecified"
    },
    "LoadAccessorials": {
      "Guaranteed": false,
      "TimeDefinite": false,
      "Expedited": false,
      "HolidayPickup": false,
      "HolidayDelivery": false,
      "WeightDetermination": false,
      "BlindShipment": false,
      "BlanketService": false,
      "ProtectFromFreezing": false,
      "SingleShipment": false,
      "CustomsInBond": false,
      "OverDimension": false,
      "Stackable": false,
      "Turnkey": false,
      "FoodGradeProducts": false,
      "TSA": false,
      "Bulkhead": false,
      "SignatureRequired": false,
      "BlanketServiceChilled": false,
      "BlanketServiceFrozen": false,
      "SaturdayDelivery": false,
      "SecondMan": false,
      "ReturnReceipt": false,
      "ShipmentHold": false,
      "ProactiveResponse": false,
      "ShipperRelease": false,
      "WhiteGlove": false,
      "RestrictedDelivery": false,
      "TankerEndorsedDriverRequired": false
    },
    "UserDefined": [],
    "ReferenceField": []
  },
  "Quotes": null,
  "PendingQuotes": null,
  "FailedQuotes": null,
  "Notes": [
    {
      "Text": "Load has been updated using the update load web method.",
      "User": "Revenova Web Services",
      "DateStamp": "2024-07-19T09:32:39",
      "NoteType": 10
    },
    {
      "Text": "Banyan Test Carrier did not rate. This shipment contains limited access requirements not supported by the carrier's rate engine.",
      "User": "Automation",
      "DateStamp": "2024-07-18T15:13:56",
      "NoteType": 15
    },
    {
      "Text": "Banyan Test Carrier: Please contact your service provider for a LTL quote.",
      "User": "Automation",
      "DateStamp": "2024-07-18T15:13:56",
      "NoteType": 15
    },
    {
      "Text": "Load Created",
      "User": "Revenova Web Services",
      "DateStamp": "2024-07-18T15:13:51",
      "NoteType": 10
    }
  ],
  "Error": null
}

TMS Field Updates

See Banyan documentation here.

Tender a Load with Third Party Quotes

The API call to the Banyan ImportForBook endpoint allows users to complete the following actions.

1. Send a Load to Banyan.

2. Send a Carrier quote and add the Carrier to the Load.

3. Tender the Carrier quote to that Carrier.

When quoting with SMC3, this API call provides tendering, tracking, and document management with Banyan.

In order to make this call, the following fields are required:

• Carrier Bill To fields.

• Banyan-supported Accessorials.

The SubmitPickup bit controls the communication to the Carrier on a successful load tender.

Sample Tender Load with Third Party Quotes Request Payload

({
  "PickupDateTime": "2018-07-25T00:00:00",
  "BOLNumber": "",
  "DispatchLoad": false,
  "DispatchOverride": true,
  "SubmitPickup": false,
  "ProNumber": "",
  "ActualCarrierName": "YRC Inc.",
  "QuoteInformation": {
    "QuoteID": null,
    "SCAC": "RDWY",
    "TransitTime": 5,
    "TotalCharge": 259.5,
    "FreightCharge": 2,
    "FuelSurcharge": 5,
    "DiscountPercentage": 0.25,
    "DiscountAmount": 0.5,
    "AccessorialFees": 0,
    "Minumum": 0,
    "GrossCharge": 58,
    "OtherCharges": 200,
    "Tariff": "1",
    "Interline": false,
    "Miles": 100,
    "QuoteNumber": "",
    "AccountNumber": "123",
    "CarrierPrice": 50,
    "CustomerPrice": 51.5,
    "Note": "This is a note.",
    "CurrencyID": 0
  },
  "AuthenticationData": {
    "Username": "",
    "Password": "",
    "ClientRefNum": ""
  },
  "Loadinfo": {
    "LoadID": null,
    "ManifestID": null,
    "BOLNumber": "SFBOL1",
    "CustomerPO": "SPPO1",
    "InvoiceID": "SPINVOICE1",
    "BillingID": null,
    "IncoTermID": null
  },
  "BillTo": {
    "Name": " Test BillTo Address",
    "Note": " Test BillTo",
    "ShipType": 0,
    "PayType": 1,
    "UseDefaultBillTo": true,
    "AddressInfo": {
      "Address1": null,
      "Address2": null,
      "City": null,
      "CountryName": null,
      "CountryCode": null,
      "State": null,
      "Zipcode": null,
      "LocationName": null
    },
    "ContactInfo": {
      "FirstName": "Test",
      "LastName": "User",
      "ContactName": "Test Contact",
      "Phone": "555-555-5555",
      "PhoneExt": null,
      "Fax": null,
      "Email": "test@.test.com"
    }
  },
  "RateServices": [
    {
      "ServiceCode": "LTL",
      "ShippingQty": 1,
      "PackageType": 29,
      "EquipmentType": 5,
      "AdditionalWeight": 0,
      "SpecialInstructions": null,
      "Length": null,
      "Width": null,
      "Height": null,
      "WeightUom": 0,
      "SizeUom": 0
    }
  ],
  "Shipper": {
    "ContactInfo": {
      "FirstName": "Test",
      "LastName": " User",
      "ContactName": "Test Contact",
      "Phone": "555-555-5555",
      "PhoneExt": null,
      "Fax": null,
      "Email": "test@.test.com"
    },
    "AddressInfo": {
      "Address1": "123 Main",
      "Address2": "",
      "City": "Cleveland",
      "CountryName": "USA",
      "CountryCode": "US",
      "State": "OH",
      "Zipcode": "12345",
      "LocationName": " Test Address"
    },
    "CompanyName": "Test Company",
    "Note": "This is a test shipper",
    "CompanyID": "SFTC",
    "LocationName": "Test Location",
    "VendorID": null,
    "DCRefNum": "Test Ref Num",
    "Dock": {
      "Name": " Test Dock",
      "Note": " Test Note",
      "OpenTime": null,
      "ShipmentDateTime": null,
      "CloseTime": null,
      "ConfirmationNumber": "12345",
      "FCFS": null
    }
  },
  "Consignee": {
    "ContactInfo": {
      "FirstName": "Test",
      "LastName": "User",
      "ContactName": " Test Contact",
      "Phone": "555-555-5555",
      "PhoneExt": null,
      "Fax": null,
      "Email": "test@.test.com"
    },
    "AddressInfo": {
      "Address1": "123 Main",
      "Address2": "",
      "City": "Cleveland",
      "CountryName": "USA",
      "CountryCode": "US",
      "State": "OH",
      "Zipcode": "12345",
      "LocationName": " Test Address"
    },
    "CompanyName": " Test Consignee Company",
    "Note": " Test Consignee",
    "CompanyID": "SFTC",
    "LocationName": " Test Consignee Location",
    "VendorID": null,
    "DCRefNum": null,
    "Dock": {
      "Name": " Test Dock",
      "Note": " Test Note",
      "OpenTime": null,
      "ShipmentDateTime": null,
      "CloseTime": null,
      "ConfirmationNumber": "12345",
      "FCFS": null
    }
  },
  "PackageInfo": {
    "CODAmount": null,
    "DeclaredLiability": null
  },
  "Products": [
    {
      "Quantity": 1,
      "PackageType": 29,
      "Weight": 10,
      "Class": 0,
      "NMFC": "12345",
      "SKU": null,
      "IsHazmat": false,
      "HazmatPhoneNumber": null,
      "HazmatPhoneExt": null,
      "Description": "TestProduct",
      "Length": 10,
      "Width": 10,
      "Height": 10,
      "UOM": 1,
      "SortOrder": 0,
      "ReferenceNumber": "123",
      "ParcelOptions": {
        "DeliveryConfirmation": 0,
        "COD": 0,
        "CODAmount": 0,
        "InsuranceAmount": 0
      }
    }
  ],
  "ShipperAccessorials": {
    "AppointmentRequired": false,
    "InsidePickup": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialPickup": false,
    "LiftgatePickup": false,
    "MarkingTagging": false,
    "TradeShowPickup": false,
    "NYCMetro": false,
    "LimitedAccessType": null
  },
  "ConsigneeAccessorials": {
    "AppointmentRequired": false,
    "InsideDelivery": false,
    "SortSegregate": false,
    "PalletJack": false,
    "ResidentialDelivery": false,
    "LiftgateDelivery": false,
    "MarkingTagging": false,
    "TradeShowDelivery": false,
    "NYCMetro": false,
    "DeliveryNotification": false,
    "TwoHourSpecialDelivery": false,
    "LimitedAccessType": null
  },
  "LoadAccessorials": {
    "Guaranteed": false,
    "TimeDefinite": false,
    "Expedited": false,
    "HolidayPickup": false,
    "HolidayDelivery": false,
    "WeightDetermination": false,
    "BlindShipment": false,
    "BlanketService": false,
    "SingleShipment": false,
    "CustomsInBond": false,
    "OverDimension": false,
    "Stackable": false,
    "Turnkey": false,
    "FoodGradeProducts": false,
    "TSA": false,
    "Bulkhead": false,
    "SignatureRequired": false,
    "BlanketServiceChilled": false,
    "BlanketServiceFrozen": false,
    "SaturdayDelivery": false
  },
  "UserDefined": [],
  "ReferenceField": []
});

Sample Tender Load with Third Party Quotes Response Payload

{
  "LoadID": 12345678,
  "QuoteInformation": {
    "QuoteID": 123456789,
    "SCAC": "RLCA",
    "TransitTime": 5,
    "TotalCharge": 259.5,
    "FreightCharge": 2,
    "FuelSurcharge": 5,
    "DiscountPercentage": 0.25,
    "DiscountAmount": 0.5,
    "AccessorialFees": 0,
    "Minumum": 0,
    "GrossCharge": 58,
    "OtherCharges": 200,
    "Tariff": "1",
    "Interline": false,
    "Miles": 100,
    "QuoteNumber": "",
    "AccountNumber": "123",
    "CarrierPrice": 50,
    "CustomerPrice": 51.5,
    "Note": "This is a note.",
    "CurrencyID": 0
  },
  "BookResponse": {
    "Success": true,
    "Error": null,
    "request": {
      "AuthenticationData": {
        "Username": null,
        "Password": null,
        "ClientRefNum": null
      },
      "Loadinfo": {
        "LoadID": null,
        "ManifestID": null,
        "BOLNumber": null,
        "CustomerPO": null,
        "InvoiceID": null,
        "BillingID": null,
        "IncoTermID": null
      },
      "BillTo": {
        "Name": null,
        "Note": null,
        "ShipType": 0,
        "PayType": 0,
        "UseDefaultBillTo": false,
        "AddressInfo": null,
        "ContactInfo": null
      },
      "InsuranceInfo": null,
      "RateServices": [],
      "Shipper": {
        "ContactInfo": {
          "FirstName": null,
          "LastName": null,
          "ContactName": null,
          "Phone": "",
          "PhoneExt": null,
          "Fax": null,
          "Email": null
        },
        "AddressInfo": {
          "Address1": null,
          "Address2": null,
          "City": null,
          "CountryName": null,
          "CountryCode": null,
          "State": null,
          "Zipcode": null,
          "LocationName": null
        },
        "CompanyName": null,
        "Note": null,
        "CompanyID": null,
        "LocationName": null,
        "VendorID": null,
        "DCRefNum": null,
        "Dock": {
          "Name": null,
          "Note": null,
          "OpenTime": null,
          "ShipmentDateTime": null,
          "CloseTime": null,
          "ConfirmationNumber": null,
          "FCFS": null
        }
      },
      "Consignee": {
        "ContactInfo": {
          "FirstName": null,
          "LastName": null,
          "ContactName": null,
          "Phone": "",
          "PhoneExt": null,
          "Fax": null,
          "Email": null
        },
        "AddressInfo": {
          "Address1": null,
          "Address2": null,
          "City": null,
          "CountryName": null,
          "CountryCode": null,
          "State": null,
          "Zipcode": null,
          "LocationName": null
        },
        "CompanyName": null,
        "Note": null,
        "CompanyID": null,
        "LocationName": null,
        "VendorID": null,
        "DCRefNum": null,
        "Dock": {
          "Name": null,
          "Note": null,
          "OpenTime": null,
          "ShipmentDateTime": null,
          "CloseTime": null,
          "ConfirmationNumber": null,
          "FCFS": null
        }
      },
      "PackageInfo": {
        "CODAmount": null,
        "DeclaredLiability": null
      },
      "Products": [],
      "ShipperAccessorials": {
        "AppointmentRequired": false,
        "InsidePickup": false,
        "SortSegregate": false,
        "PalletJack": false,
        "ResidentialPickup": false,
        "LiftgatePickup": false,
        "MarkingTagging": false,
        "TradeShowPickup": false,
        "NYCMetro": false,
        "NonBusinessHourPickup": false,
        "LimitedAccessType": null
      },
      "ConsigneeAccessorials": {
        "AppointmentRequired": false,
        "InsideDelivery": false,
        "SortSegregate": false,
        "PalletJack": false,
        "ResidentialDelivery": false,
        "LiftgateDelivery": false,
        "MarkingTagging": false,
        "TradeShowDelivery": false,
        "NYCMetro": false,
        "DeliveryNotification": false,
        "TwoHourSpecialDelivery": false,
        "NonBusinessHourDelivery": false,
        "LimitedAccessType": null
      },
      "LoadAccessorials": {
        "Guaranteed": false,
        "TimeDefinite": false,
        "Expedited": false,
        "HolidayPickup": false,
        "HolidayDelivery": false,
        "WeightDetermination": false,
        "BlindShipment": false,
        "BlanketService": false,
        "SingleShipment": false,
        "CustomsInBond": false,
        "OverDimension": false,
        "Stackable": false,
        "Turnkey": false,
        "FoodGradeProducts": false,
        "TSA": false,
        "Bulkhead": false,
        "SignatureRequired": false,
        "BlanketServiceChilled": false,
        "BlanketServiceFrozen": false,
        "SaturdayDelivery": false,
        "SecondMan": false,
        "ReturnReceipt": false,
        "ShipmentHold": false,
        "ProactiveResponse": false,
        "ShipperRelease": false,
        "WhiteGlove": false,
        "RestrictedDelivery": false
      },
      "UserDefined": [],
      "ReferenceField": []
    },
    "DispatchResponse": {
      "LoadID": 0,
      "Success": false,
      "PickupNumber": null,
      "CarrierName": null,
      "QuoteNumber": null,
      "EstimatedDeliveryDate": "0001-01-01T00:00:00",
      "ProNumber": null,
      "UserMessage": null,
      "BOLLink": null,
      "Errors": null,
      "Warnings": null
    },
    "ProNumber": null
  }
}

TMS Field Updates

See Banyan documentation here.

Remove Carrier from a Load

The UnbookLoad endpoint is called in two scenarios.

1. When an error occurs while tendering a load to Banyan.

2. When a Carrier is removed from a load from the Carrier Banner.

   • See information on the Carrier Banner LWC for instructions on removing a Carrier from a load.

Sample Remove Carrier from Load Request Payload

({
  "AuthenticationData": {
    "Username": "",
    "Password": "",
    "ClientRefNum": ""
  },
  "LoadID": ""
});

The call to the Banyan UnbookLoad endpoint removes the Carrier from the load. This call has no communication with the Carrier.

Carriers cannot be removed from loads that are already dispatched.

When the Carrier is removed, the load is set to an Unassigned status.

Sample Remove Carrier from Load Response Payload

{
  "LoadID": 13624203,
  "Success": true,
  "Error": null
}

TMS Field Updates

See Banyan documentation here.

Tracking Status Updates

When requested, Banyan sends load tracking status updates to the TMS.

This call returns all of the tracking statuses for the web service user’s super user group. The tracking statuses are gathered by automated tracking from Banyan. Each tracking status is only sent to the TMS once. Any Carrier messages received in the response from Banyan are directly from the Carrier. Banyan does not adjust these messages.

Set the following fields to control load tracking updates from Banyan.

Banyan Tracking Notes

• Banyan only returns status information when there are updates to any loads.

• Tracking is NOT controlled on the Load Tracking Administration modal. Banyan does not “push” tracking updates to Revenova.

Load tracking updates are initiated by the BanyanJob. The BanyanJob is activated by the LoadStatusUpdateJob.

See more information regarding batch processes here.

Sample Tracking Status Updates Request Payload

({
  "AuthenticationData": {
    "Username": "username",
    "Password": "password",
    "ClientRefNum": ""
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

Sample Tracking Status Updates Response Payload

{
  "TrackingStatuses": [
    {
      "LoadID": 12345678,
      "BOL": "3000555567",
      "ProNumber": "207000555",
      "DateTime": null,
      "Code": "T1",
      "CarrierMessage": "En route to interim Bismarck, ND ",
      "BanyanMessage": "In Transit",
      "City": "Bismarck",
      "State": "ND"
    },
    {
      "LoadID": 87654321,
      "BOL": "3000123456",
      "ProNumber": "207555000",
      "DateTime": null,
      "Code": "T2",
      "CarrierMessage": "En route to destination Lumberton, NC ",
      "BanyanMessage": "En Route to Delivery Location",
      "City": "Lumberton",
      "State": "NC"
    }
  ],
  "Success": true,
  "Error": null
}

TMS Field Updates

See Banyan documentation here.

Get Load Documents

In addition to load tracking statuses, the BanyanJob also initiates the call to the GetDocuments endpoint. This call retrieves load documents (BOL and POD) for loads with a Delivered or Completed status only. See the list of supported document types below.

Documents are retrieved for loads with:

1. A Last Stop Expected Date within the last 5 days. OR

2. A Last Stop Arrival Date in the last 5 days. OR

3. A Last Stop Departure Date in the last 5 days.

Permissions are required to view certain documents. (Usually AP and AR documents.) Contact Banyan if certain documents are not available.

Sample Get Load Documents Request Payload

({
  "AuthenticationData": {
    "Username": "username",
    "Password": "password",
    "ClientRefNum": ""
  },
  "LoadID": "",
  "Documents": [
    "Carrier_Label"
  ]
});

Sample Get Load Documents Response Payload

{
  "LoadID": 123456789,
  "Documents": [
    {
      "DocumentType": 5,
      "Base64Documents": [],
      "ZPLDocuments": null,
      "Success": false,
      "Error": {
        "<Message>k__BackingField": "Permission not set to View the AP invoice document"
      }
    }
  ],
  "Success": true,
  "Error": null
}

TMS Field Updates

See Banyan documentation here.

Banyan Codes

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.

Accessorials

• The Hazardous Material accessorial does not require an accessorial subcode.

• The Unspecified Limited Access Pickup and Delivery accessorial charges cannot be Load type accessorials. If these Load type accessorial charges are added to a Load automatically by Rate Entry, they are not included when quoting Loads.

Load Accessorials

Pickup Accessorials

Delivery Accessorials

Package Types

Ship Types

Document Types

Failure

The following table contains failure codes that can appear in the TMS user interface.

Integration Field Mapping

The following table relates TMS data fields with the equivalent Banyan fields included in API calls.