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 - v1

Standard Load Export v1#

Version 1 of our Standard Load Export contains standard information about a shipment. It includes items such as the accepted quote, the shipper and consignee, line items, billto information, reference numbers, BOL and Pro number.

Json Example
Xml Example
      {
        "AcceptedQuote": {
            "AccountId": "Sample Account",
            "CarrierName": "Sample Carrier",
            "CarrierSCAC": "SMPL",
            "CarrierServiceLevelName": null,
            "Currency": "USD",
            "DateStamp": "2019-06-28T16:23:19.763",
            "Interline": false,
            "LoadServiceId": 99999999,
            "Miles": -1,
            "Note": "",
            "PricingDetails": [
                {
                    "AdditionalCharges": [
                        {
                            "Amount": 10.0,
                            "Code": "CLFTG",
                            "Name": "Liftgate Delivery"
                        }
                    ],
                    "Discount": 0.0,
                    "FreightCharge": 75.0,
                    "FuelSurcharge": 15.23,
                    "GrossCharge": 75.0,
                    "Markups": [],
                    "MinimumCharge": 75.0,
                    "TotalCharge": 100.23,
                    "Type": "Raw Charges"
                },
                {
                    "AdditionalCharges": [
                        {
                            "Amount": 10.0,
                            "Code": "CLFTG",
                            "Name": "Liftgate Delivery"
                        }
                    ],
                    "Discount": 0.0,
                    "FreightCharge": 75.0,
                    "FuelSurcharge": 15.23,
                    "GrossCharge": 75.0,
                    "Markups": [
                        {
                            "Amount": 10.02,
                            "Code": null,
                            "Name": "Variable Percent Markup"
                        }
                    ],
                    "MinimumCharge": 75.0,
                    "TotalCharge": 110.25,
                    "Type": "Carrier Charges"
                },
                {
                    "AdditionalCharges": [
                        {
                            "Amount": 10.0,
                            "Code": "CLFTG",
                            "Name": "Liftgate Delivery"
                        }
                    ],
                    "Discount": 0.0,
                    "FreightCharge": 75.0,
                    "FuelSurcharge": 15.23,
                    "GrossCharge": 75.0,
                    "Markups": [
                        {
                            "Amount": 10.02,
                            "Code": null,
                            "Name": "Variable Percent Markup"
                        }
                    ],
                    "MinimumCharge": 75.0,
                    "TotalCharge": 110.25,
                    "Type": "Customer Charges"
                }
            ],
            "QuoteId": 999999999,
            "QuoteNumber": "999999",
            "ServiceType": null,
            "TransitTime": 0
        },
        "Accessorials": [],
        "ActualDeliveryDate": "2019-06-28T00:00:00",
        "ActualPickupDate": "2019-06-28T00:00:00",
        "Billing": {
            "Address1": "3333 Sample Street",
            "Address2": "",
            "City": "Vancouver",
            "ContactName": "N/A",
            "Country": "United States",
            "CountryCode": "USA",
            "Email": "sample@sample.com",
            "Fax": "",
            "LocationName": "Sample Billing",
            "Name": "Sample Billing LLC",
            "Note": "",
            "Phone": "999-999-9999",
            "PhoneExt": "",
            "PostalCode": "98660",
            "StandardCountryCode": "US",
            "State": "WA"
        },
        "BillingId": "9999999",
        "BOLNumber": "SAMPLEBOLNUMBER",
        "BookedBy": "Sample User",
        "BookedReason": "Service Not Available",
        "CancelledBy": null,
        "ClientId": 34146,
        "ClientName": "Sample Client",
        "ClientRefNumber": "ABC",
        "CODAmount": 0.0,
        "CODFeesPaidBy": null,
        "CreatedBy": "Automation",
        "CreatedDate": "2019-06-28T16:19:13.96",
        "CustomerPO": "00001",
        "DeclaredLiability": 0.0,
        "DeliveryTime": "2019-06-19T12:00:00",
        "Destination": {
            "Accessorials": [
                {
                    "Code": "CLFTG",
                    "Name": "Liftgate Delivery"
                }
            ],
            "Address1": "55555 Sample Road",
            "Address2": "",
            "City": "Elizabeth",
            "ContactName": "Sample Destination Contact ",
            "Country": "United States",
            "CountryCode": "USA",
            "Dock": {
                "DockCloseTime": "2019-06-19T17:00:00",
                "DockName": "Main Dock",
                "DockNote": "",
                "DockOpenTime": "2019-06-19T08:00:00",
                "FCFS": false,
                "LimitedAccess": "None",
                "ReferenceNumber": ""
            },
            "Email": "sample@destination.com",
            "Fax": "",
            "LocationName": "Sample Destination",
            "Name": "Sample",
            "Phone": "(555) 555-5555",
            "PhoneExt": "",
            "PostalCode": "80107",
            "StandardCountryCode": "US",
            "State": "CO",
            "VendorId": null
        },
        "EstimatedDeliveryDate": "2019-06-19T12:00:00",
        "EstimatedPickupDate": "2019-06-28T00:00:00",
        "Incoterm": null,
        "InternationalTaxNumber": null,
        "InvoiceId": "9999999",
        "LoadId": 99999999,
        "LoadServices": [
            {
                "AdditionalWeight": 0.0,
                "EquipmentType": "Van-standard trailer",
                "Height": null,
                "Length": null,
                "LoadServiceId": 99999999,
                "PackageType": "Pallets",
                "ServiceType": "LTL",
                "ShippingQuantity": 1,
                "SpecialInstructions": "Do Not Double Stack Pallets.  Do Not Break Down Pallets.",
                "Width": null
            }
        ],
        "Origin": {
            "Accessorials": [],
            "Address1": "4444 Sample Way",
            "Address2": "Unit A",
            "City": "Aurora",
            "ContactName": "Sample Origin Contact",
            "Country": "United States",
            "CountryCode": "USA",
            "Dock": {
                "DockCloseTime": "2019-06-19T17:00:00",
                "DockName": "Main Dock",
                "DockNote": "",
                "DockOpenTime": "2019-06-19T08:00:00",
                "FCFS": false,
                "LimitedAccess": "None",
                "ReferenceNumber": ""
            },
            "Email": "sample@origin.com",
            "Fax": "",
            "LocationName": "Sample Origin",
            "Name": "Sample",
            "Phone": "(333) 333-3333",
            "PhoneExt": "",
            "PostalCode": "80011",
            "StandardCountryCode": "US",
            "State": "CO",
            "VendorId": null
        },
        "PayType": "Prepaid",
        "PickupNumber": "",
        "PickupTime": "2019-06-28T12:00:00",
        "PreviousStatus": null,
        "Products": [
            {
                "AdditionalHandling": false,
                "Class": "50",
                "CODAmount": 0.0,
                "Code": "",
                "CODType": null,
                "DeliveryConfirmation": null,
                "Description": "Products that were produced by production",
                "ECCN": null,
                "HarmonizedSystemCode": null,
                "HazMat": false,
                "HazMatClass": "",
                "HazMatContact": "",
                "HazMatPhone": "",
                "HazMatPhoneExt": "",
                "HazMatPkgGroup": "",
                "HazMatShippingName": "",
                "Height": 0.0,
                "InsuranceAmount": 0.0,
                "LargePackage": false,
                "Length": 0.0,
                "LinearUom": "IN",
                "NMFC": "",
                "OriginCountry": null,
                "OriginCountryCode": null,
                "OriginStandardCountryCode": null,
                "PackageType": "Pieces",
                "ProductId": 0,
                "Quantity": 36,
                "ScheduleBCode": null,
                "SKU": "1410855",
                "UnitType": "Pieces",
                "UnitValue": null,
                "UnitWeight": null,
                "UNNumber": "",
                "Volume": null,
                "Weight": 2540.0,
                "WeightUom": "LBS",
                "Width": 0.0
            }
        ],
        "PRONumber": "ABC999999999",
        "References": [],
        "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": "Shipper",
        "Status": "Delivered",
        "TrailerNumber": null,
        "UnBookedBy": null
    }
Modified at 2024-09-16 11:42:18
Previous
Exports and Webhooks
Next
Standard Load Export - v2
Built with