Banyan Technology LIVE Connect™
  1. Version 3
Banyan Technology LIVE Connect™
  • Version 3
    • Authentication
      • Retrieve a token
    • Shipments
      • Creating
        • Create a Full Shipment
        • Create an EZ Rate Shipment
      • Updating
        • Add Document(s) to a Shipment
        • Update a Shipment
        • Adds one or more Reference Numbers to a Shipment
        • Mark as Exported
      • Retrieving
        • Get a Shipment
        • Get multiple Shipments
        • Get Quotes
        • Get Reference Numbers for a Shipment
        • Get documents for the specified shipment.
      • Booking
        • Book a Shipment
        • Unbooks the awarded quote on the specified load.
      • Canceling
        • Cancels a shipment.
    • Invoice
      • Get multiple invoices
      • Mark as Exported
    • Tracking
      • Get tracking statuses
      • Mark as exported.
    • StaticData
      • Accessorials
      • Document Types
      • Equipment Types
      • Package Types
      • Limited Access Types
      • Size UOMs
      • Weight UOMs
      • Pay Types
      • Ship Types
      • Countries
      • Statuses
      • Service Modes
  • Version 2
    • Recommended Workflow
      • Rating
        • ImportForQuote
        • ImportForQuote_Sync
        • GetQuotes
      • Booking/Dispatching
        • BookLoad
      • Tracking
        • GetTrackingStatuses
      • Documents
        • GetDocuments
      • Invoices
        • GetInvoices
        • GetInvoicesWithLoadDetails
    • Additional Offerings
      • Cancelling
        • Cancel a Load
      • Updating
        • UpdateLoad
        • UpdateLoadStatus
        • UpdateShipmentsExport
      • Importing
        • PendingImport
        • ImportForBook
      • Manual Quotes
        • AddManualQuote
      • EZ Rates
        • EzRate
        • EzRate_Sync
      • Waterfall Tendering
        • StartWaterfallTendering
        • CancelWaterfallTendering
      • Unbooking
        • UnBookLoad
      • Additional Dispatching
        • DispatchLoad
      • Load Details
        • GetLoadDetails
        • GetNotes
      • Additional Tracking
        • GetTrackingByLoad
      • Other
        • Normalized Charge Codes
      • SOAP
    • Changelog
  • Exports and Webhooks
    • Standard Load Export - v1
    • Standard Load Export - v2
    • Standard Load Export - v3
    • Push Tracking
  1. Version 3

Shipments

Consolidation of import endpoints#

In version 2 of our web services, there are seperate endpoints for importing to each status and seperate endpoints for synchronous and asynchronous rating.
With version 3, we have simplified this into 1 endpoint. Using enums and boolean values you can control which type of shipment you create, which status it will be created in and if you want a response immediately or if you want to wait for rating to complete.
AttributeTypeDescription
WaitForRatesboolWhen true, a response will be returned when the rating engine is complete. Setting to false will return a response immediately.
ImportAsStatusstringThis allows you to specify which status the shipment will be imported as.
IsEzRateboolWhen true, the shipment will be created as an EZ Rate with minimal data. EZ Rates require less data and are useful for quick zip to zip rates.
ShouldRunRatesboolIn most cases this should be true (default). When importing in a booked status, it can be set to false, and manual quote data must be passed.

Support for new product enhancements#

Please reach out to your account manager to learn more about these services.#

AttributeTypeDescription
pullMarketRatesboolWhen true, the market rates for this shipment will be provided by Greenscreens.ai. Access intelligent, AI-driven predictive Truckload pricing to protect your bottom line.
requestCarbonServiceboolWhen creating and rating a shipment, the system will request a carbon footprint calculation and estimate for the cost of offset. If the shipment is going to booked or further status, the offset will be purchased if the user has permission to do so. If false (default), no additional processing occurs.

Handling Units#

Handling units are useful for building out more complext shipments. For example, 1 pallet (handling unit) with 20 boxes (products) and 2 boxes (handling unit) with several loose items.
AttributeTypeDescription
HandlingUnitsarrayThe handling units containing the products.

For shipments that cannot utilize handling units, supply a single handling unit with 0 for quantity, and None for package type, and the shipment will not create handling units.
Previous
Retrieve a token
Next
Create a Full Shipment
Built with