Banyan Technology LIVE Connect™
  1. Exports and Webhooks
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. Exports and Webhooks

Standard Load Export - v3

Standard Load Export v3#

Version 3 of our Standard Load Export offers the same information as v2, with the addition Freight Bill Data.

Json Example
Xml Example
      
      {
          "AcceptedQuote": {
            "AccountId": "426499",
            "CarrierName": "Roadrunner Transportation Services Inc",
            "CarrierSCAC": "RDFS",
            "CarrierServiceLevelName": null,
            "Currency": "USD",
            "DateStamp": "2022-07-06T11:24:23.66",
            "Interline": false,
            "LoadServiceId": 45941476,
            "Miles": null,
            "Note": "",
            "PricingDetails": [
              {
                "AdditionalCharges": [
                  {
                    "Amount": 23.7,
                    "Code": "GLHC",
                    "Name": "Linehaul Charge"
                  }
                ],
                "Discount": 0,
                "FreightCharge": 69.9,
                "FuelSurcharge": 34.43,
                "GrossCharge": 69.9,
                "Markups": [],
                "MinimumCharge": 69.9,
                "TotalCharge": 128.03,
                "Type": "Raw Charges"
              },
              {
                "AdditionalCharges": [
                  {
                    "Amount": 23.7,
                    "Code": "GLHC",
                    "Name": "Linehaul Charge"
                  }
                ],
                "Discount": 0,
                "FreightCharge": 69.9,
                "FuelSurcharge": 34.43,
                "GrossCharge": 69.9,
                "Markups": [],
                "MinimumCharge": 69.9,
                "TotalCharge": 128.03,
                "Type": "Carrier Charges"
              },
              {
                "AdditionalCharges": [
                  {
                    "Amount": 23.7,
                    "Code": "GLHC",
                    "Name": "Linehaul Charge"
                  }
                ],
                "Discount": 0,
                "FreightCharge": 95.51,
                "FuelSurcharge": 34.43,
                "GrossCharge": 95.51,
                "Markups": [
                  {
                    "Amount": 25.61,
                    "Code": null,
                    "Name": "Customer Markup"
                  }
                ],
                "MinimumCharge": 69.9,
                "TotalCharge": 153.64,
                "Type": "Customer Charges"
              }
            ],
            "QuoteId": 368222760,
            "QuoteNumber": "5283124",
            "ServiceType": "LTL",
            "TransitTime": 2
          },
          "Accessorials": [],
          "ActualDeliveryDate": "2022-07-06T00:00:00",
          "ActualPickupDate": "2022-07-06T00:00:00",
          "Billing": {
            "Address1": "10380 NW Ambassador Drive",
            "Address2": "#102",
            "City": "Kansas City",
            "ContactName": "N/A",
            "Country": "United States",
            "CountryCode": "USA",
            "Email": "ltlops@trinitylogistics.com",
            "Fax": "",
            "LocationName": "Trinity Logistics, Inc.",
            "Name": "Trinity Logistics, Inc.",
            "Note": "",
            "Phone": "800-846-3400",
            "PhoneExt": "",
            "PostalCode": "64153",
            "StandardCountryCode": "US",
            "State": "MO"
          },
          "BillingId": "",
          "BOLNumber": "BWS2218700003",
          "BookedReason": null,
          "ClientId": 45086,
          "ClientName": "Banyan Web Services - Test Only",
          "ClientRefNumber": "BWSTO123",
          "CODAmount": 0,
          "CODFeesPaidBy": null,
          "CreatedBy": "Brooke Berbari",
          "CreatedDate": "2022-07-06T11:22:57.15",
          "CustomerPO": "",
          "DeclaredLiability": 0,
          "DeliveryTime": "2022-07-06T12:00:00",
          "Destination": {
            "Accessorials": [],
            "Address1": "321 WEST",
            "Address2": "",
            "City": "Chicago",
            "ContactName": "N/A",
            "Country": "United States",
            "CountryCode": "USA",
            "Dock": {
              "DockCloseTime": "2022-07-06T17:00:00",
              "DockName": "Main Dock",
              "DockNote": "",
              "DockOpenTime": "2022-07-06T08:00:00",
              "FCFS": false,
              "LimitedAccess": "None",
              "ReferenceNumber": ""
            },
            "Email": "",
            "Fax": "",
            "LocationName": "TEST CONSIGNEE",
            "Name": "TEST CONSIGNEE",
            "Phone": "",
            "PhoneExt": "",
            "PostalCode": "60601",
            "StandardCountryCode": "US",
            "State": "IL",
            "VendorId": null
          },
          "EstimatedDeliveryDate": "2022-07-08T00:00:00",
          "EstimatedPickupDate": "2022-07-06T00:00:00",
          "Incoterm": null,
          "InternationalTaxNumber": "",
          "InvoiceId": "",
          "LoadId": 41850555,
          "LoadServices": [
            {
              "AdditionalWeight": 0,
              "EquipmentType": "Van-standard trailer",
              "Height": null,
              "Length": null,
              "LoadServiceId": 45941476,
              "PackageType": "Pallets",
              "ServiceType": "LTL",
              "ShippingQuantity": 1,
              "SpecialInstructions": "",
              "Width": null
            }
          ],
          "Origin": {
            "Accessorials": [],
            "Address1": "123 EAST",
            "Address2": "",
            "City": "Cleveland",
            "ContactName": "N/A",
            "Country": "United States",
            "CountryCode": "USA",
            "Dock": {
              "DockCloseTime": "2022-07-06T17:00:00",
              "DockName": "Main Dock",
              "DockNote": "",
              "DockOpenTime": "2022-07-06T08:00:00",
              "FCFS": false,
              "LimitedAccess": "None",
              "ReferenceNumber": ""
            },
            "Email": "",
            "Fax": "",
            "LocationName": "TEST SHIPPER",
            "Name": "TEST SHIPPER",
            "Phone": "",
            "PhoneExt": "",
            "PostalCode": "44101",
            "StandardCountryCode": "US",
            "State": "OH",
            "VendorId": null
          },
          "PayType": "Prepaid",
          "PickupNumber": "",
          "PickupTime": "2022-07-06T12:00:00",
          "PreviousStatus": null,
          "Products": [
            {
              "AdditionalHandling": false,
              "Class": "50",
              "CODAmount": null,
              "Code": "",
              "CODType": null,
              "DeliveryConfirmation": null,
              "Description": "",
              "ECCN": null,
              "HarmonizedSystemCode": null,
              "HazMat": false,
              "HazMatClass": null,
              "HazMatContact": null,
              "HazMatPhone": null,
              "HazMatPhoneExt": null,
              "HazMatPkgGroup": null,
              "HazMatShippingName": null,
              "Height": 12,
              "InsuranceAmount": null,
              "LargePackage": false,
              "Length": 12,
              "LinearUom": "IN",
              "NMFC": "",
              "OriginCountry": null,
              "OriginCountryCode": null,
              "OriginStandardCountryCode": null,
              "PackageType": "Pallets",
              "ProductId": 0,
              "Quantity": 1,
              "ScheduleBCode": null,
              "SKU": "",
              "UnitType": "Pallets",
              "UnitValue": null,
              "UnitWeight": null,
              "UNNumber": null,
              "Volume": 1728,
              "Weight": 123,
              "WeightUom": "LBS",
              "Width": 12
            }
          ],
          "PRONumber": "",
          "References": [
            {
              "Name": null,
              "Value": ""
            },
            {
              "Name": "Assigned Dispatcher",
              "Value": ""
            },
            {
              "Name": "SO #",
              "Value": ""
            },
            {
              "Name": "Customer Reference #",
              "Value": ""
            }
          ],
          "ReturnLocation": {
            "Address1": null,
            "Address2": null,
            "City": null,
            "ContactName": null,
            "Country": null,
            "CountryCode": null,
            "Email": null,
            "Fax": null,
            "LocationName": null,
            "Name": null,
            "Phone": null,
            "PhoneExt": null,
            "PostalCode": null,
            "StandardCountryCode": null,
            "State": null
          },
          "SealNumber": null,
          "ShipType": "ThirdParty",
          "Status": "Delivered",
          "StatusDetails": {
            "CurrentStatusTime": "2022-07-06T11:29:32.22",
            "OpenStatusTime": "2022-07-06T11:24:09.107",
            "PendingStatusTime": "2022-07-06T11:22:57.153",
            "QuotedStatusTime": "2022-07-06T11:24:19.46",
            "BookedStatusTime": "2022-07-06T11:25:04.97",
            "BookedBy": "Brooke Berbari",
            "UnbookedTime": null,
            "UnbookedBy": null,
            "DispatchedStatusTime": "2022-07-06T11:25:28.02",
            "InTransitStatusTime": "2022-07-06T11:26:14.92",
            "DeliveredStatusTime": "2022-07-06T11:29:32.22",
            "CancelledStatusTime": null,
            "CancelledBy": null
          },
          "Stops": [],
          "TrailerNumber": null,
          "FreightBillData": {
            "ApId": 7246058,
            "ClientId": 45086,
            "LoadId": 41850555,
            "Bolid": "BWS2218700003",
            "CustomerPo": "",
            "ShipmentDetails": {
              "TotalWeight": 123,
              "TotalPieces": 1,
              "PickupDate": "2022-07-06T00:00:00",
              "DeliveryDate": "2022-07-08T00:00:00",
              "WeightUnit": "LBS                 ",
              "Scac": "RDFS      ",
              "CarrierId": 15408
            },
            "InvoiceNumber": null,
            "BatchDetails": {
              "BatchId": null,
              "BatchUserId": null,
              "BatchDate": null
            },
            "StatusCode": "OPN  ",
            "TransactionControlNumber": null,
            "AccountNumber": null,
            "PayType": "Prepaid     ",
            "BillingDate": "2022-07-06T00:00:00",
            "NetAmountDue": 128.03,
            "TotalCharges": 128.03,
            "CurrencyCode": "USD  ",
            "SenderReceiverId": null,
            "PartnerReceiverId": null,
            "CorrectionIndicator": null,
            "Edi": false,
            "EdiDetails": null,
            "Owner": null,
            "Type": "AP",
            "RelatedToApid": -1,
            "PrintedDate": null,
            "ProductionTransaction": true,
            "IsAccepted": false,
            "WasShortPaid": false,
            "Problems": {
              "HasIssues": false,
              "HasException": false,
              "HasOperationIssue": false
            },
            "LinkedInvoices": null,
            "Emailed": null,
            "Comment": null,
            "CommentDate": null,
            "CommentUserId": null,
            "ServiceId": 2,
            "VendorId": null,
            "IsPodAvailable": false,
            "IsBolAvailable": false,
            "EdiTypeId": null,
            "SuperUsers": [
              1393,
              3878
            ]
          }
        }
      
Modified at 2024-09-16 11:42:18
Previous
Standard Load Export - v2
Next
Push Tracking
Built with