Banyan Technology LIVE Connect™
  1. Load Details
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
          POST
        • GetNotes
          POST
      • 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. Load Details

GetLoadDetails

POST
/services/api/rest/getLoadDetails
Used for retrieving details about specific Loads.

Request

Header Params
Accept
string 
required
Example:
application/json
Body Params application/json
AuthenticationData
object 
required
Banyan Credentials
Username
string 
required
Password
string 
required
ClientRefNum
string 
required
LoadIds
array[integer]
required
A list of one or more LoadIds
Example
{
  "AuthenticationData": {
    "Username": "ExampleUser",
    "Password": "Password123",
    "ClientRefNum": ""
  },
  "LoadIds": [
    1234
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/getLoadDetails' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AuthenticationData": {
        "Username": "ExampleUser",
        "Password": "Password123",
        "ClientRefNum": ""
    },
    "LoadIds": [
        1234
    ]
}'

Responses

🟢200GetLoadDetails
application/json
Body
LoadDetails
array[object (FullLoadDetails) {18}] 
required
ClientName
string 
optional
Name of client that the load is under
Status
string 
optional
Description of current status
LoadInfo
object (Loadinfo) 
required
Shipment Identifiers
BillTo
object (BillTo) 
required
Billing Information
RateServices
array[object (RateServices) {11}] 
required
Shipment Service(s)
Shipper
object (Shipper) 
required
Shipper Information
Consignee
object (Consignee) 
required
Consignee Information
PackageInfo
object (PackageInfo) 
required
Package Information
Products
array[object (Product) {24}] 
required
Shipment Product(s)
ShipperAccessorials
object (ShipperAccessorials) 
required
Shipper Accessorials
ConsigneeAccessorials
object (ConsigneeAccessorials) 
required
Consignee Accessorials
LoadAccessorials
object (LoadAccessorials) 
required
Load Accessorials
Return Location
object (ReturnLocation) 
optional
UserDefined
array[object (UserDefined) {2}] 
optional
Shipment user defined fields
ReferenceField
array[object (ReferenceField) {4}] 
optional
Shipment reference fields
InsuranceInfo
object (InsuranceInfo) 
optional
Shipment Insurance
Quotes
array[object (Quote) {21}] 
optional
Notes
array[object (Note) {4}] 
optional
List of Notes
Success
boolean 
required
Whether request was successful
Errors
array[string]
required
Example
{
  "LoadDetails": [
    {
      "Quotes": [
        {
          "LoadID": 25098029,
          "QuoteID": 219725578,
          "CarrierName": "Banyan Test Carrier",
          "SCAC": "BTST",
          "ThirdPartyName": "",
          "ThirdPartySCAC": "",
          "ServiceID": "28316781",
          "RawPrice": {
            "NetPrice": 10,
            "FreightCharge": null,
            "DiscountAmount": null,
            "FuelSurcharge": null,
            "Minimum": null,
            "GrossCharge": null,
            "Tariff": null,
            "Interline": 0,
            "AccessorialCharges": null,
            "OtherCharges": null,
            "Charges": null,
            "Markup": null
          },
          "CarrierPrice": {
            "NetPrice": 10.53,
            "FreightCharge": null,
            "DiscountAmount": null,
            "FuelSurcharge": null,
            "Minimum": null,
            "GrossCharge": null,
            "Tariff": null,
            "Interline": 0,
            "AccessorialCharges": null,
            "OtherCharges": null,
            "Charges": null,
            "Markup": null
          },
          "CustomerPrice": {
            "NetPrice": 10.53,
            "FreightCharge": null,
            "DiscountAmount": null,
            "FuelSurcharge": null,
            "Minimum": null,
            "GrossCharge": null,
            "Tariff": null,
            "Interline": 0,
            "AccessorialCharges": null,
            "OtherCharges": null,
            "Charges": null,
            "Markup": null
          },
          "TransitTime": 1,
          "QuoteNumber": "",
          "CarrierPerson": "Test Carrier Automated Quote",
          "CarrierNote": "",
          "Datestamp": "2019-10-08T10:39:18",
          "Interline": false,
          "Accepted": true,
          "CurrencyType": 0,
          "Service": 1,
          "InsuranceDetails": null
        }
      ],
      "ClientName": "Banyan Automated Testing",
      "Status": "Delivered",
      "Notes": [
        {
          "Text": "Exported via accounting export. Export guid: 60278691-289c-4d99-8987-2e6af6a5bcac.",
          "User": "John Lee",
          "DateStamp": "2019-08-26T12:21:00",
          "NoteType": 10
        }
      ],
      "Loadinfo": {
        "LoadID": 26315274,
        "ManifestID": "089527392",
        "BOLNumber": "TX1921200016",
        "CustomerPO": "246483",
        "InvoiceID": "",
        "BillingID": "",
        "IncoTermID": null,
        "UltimateDestinationCountryCode": "",
        "PickupNumber": "37286494",
        "EstimatedDeliveryDate": "2019-08-06T00:00:00",
        "EstimatedPickupDate": "2019-08-02T00:00:00",
        "ActualPickupDate": "2019-08-02T00:00:00",
        "ActualDeliveryDate": "2019-08-06T00:00:00"
      },
      "BillTo": {
        "Name": "Banyan Automated Testing",
        "Note": "",
        "ShipType": 2,
        "PayType": 1,
        "UseDefaultBillTo": false,
        "AddressInfo": {
          "Address1": "31011 Viking Pkwy",
          "Address2": "",
          "City": "Westlake",
          "CountryName": null,
          "CountryCode": "United States",
          "State": "OH",
          "Zipcode": "44145",
          "LocationName": "Banyan HQ"
        },
        "ContactInfo": {
          "FirstName": "",
          "LastName": "",
          "ContactName": "",
          "Phone": "123-456-7890",
          "PhoneExt": "",
          "Fax": "",
          "Email": "test@banyantechnology.com"
        },
        "UseDefaultShipType": false,
        "UseDefaultPayType": false
      },
      "InsuranceInfo": null,
      "RateServices": [
        {
          "ServiceCode": 1,
          "ShippingQty": 1,
          "PackageType": 29,
          "EquipmentType": 5,
          "AdditionalWeight": 0,
          "SpecialInstructions": "This is just a test shipment.",
          "Length": null,
          "Width": null,
          "Height": null,
          "WeightUom": 1,
          "SizeUom": 1
        }
      ],
      "Shipper": {
        "ContactInfo": {
          "FirstName": "Bob",
          "LastName": "Wright",
          "ContactName": "Bob Wright",
          "Phone": "555-555-5555",
          "PhoneExt": "",
          "Fax": "444-444-4444",
          "Email": "example@test.com"
        },
        "AddressInfo": {
          "Address1": "123 Test Dr.",
          "Address2": "",
          "City": "Chicago",
          "CountryName": null,
          "CountryCode": "United States",
          "State": "IL",
          "Zipcode": "60606",
          "LocationName": "Test Location"
        },
        "CompanyName": "Bob's Company",
        "Note": "",
        "CompanyID": "",
        "LocationName": null,
        "VendorID": "",
        "DCRefNum": null,
        "Dock": {
          "Name": "Bob's Garage",
          "Note": "",
          "OpenTime": "2019-11-01T08:00:00",
          "ShipmentDateTime": "2019-11-01T12:00:00",
          "CloseTime": "2019-11-01T17:00:00",
          "ConfirmationNumber": "",
          "FCFS": false
        }
      },
      "Consignee": {
        "ContactInfo": {
          "FirstName": "Joe",
          "LastName": "Smith",
          "ContactName": "Joe Smith",
          "Phone": "333-333-3333",
          "PhoneExt": "",
          "Fax": "222-222-2222",
          "Email": "jsmith@test.com"
        },
        "AddressInfo": {
          "Address1": "123 Test St.",
          "Address2": "",
          "City": "Cleveland",
          "CountryName": null,
          "CountryCode": "United States",
          "State": "OH",
          "Zipcode": "44101",
          "LocationName": "Test Location"
        },
        "CompanyName": "Joe's Company",
        "Note": "Note Here",
        "CompanyID": "",
        "LocationName": null,
        "VendorID": "",
        "DCRefNum": null,
        "Dock": {
          "Name": "Garage",
          "Note": "",
          "OpenTime": "2019-11-04T08:00:00",
          "ShipmentDateTime": "2019-11-04T12:00:00",
          "CloseTime": "2019-11-04T17:00:00",
          "ConfirmationNumber": "",
          "FCFS": false
        }
      },
      "ReturnLocation": null,
      "PackageInfo": {
        "CODAmount": 0,
        "DeclaredLiability": 0,
        "RouteNumber": ""
      },
      "Products": [
        {
          "Quantity": 1,
          "PackageType": 7,
          "Weight": 800,
          "Class": 1,
          "NMFC": "",
          "SKU": "",
          "IsHazmat": false,
          "HazmatPhoneNumber": "",
          "HazmatPhoneExt": "",
          "Description": "",
          "Length": 3.33,
          "Width": 4,
          "Height": 2.5,
          "UOM": 0,
          "SortOrder": 0,
          "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": "School"
      },
      "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,
        "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
      },
      "UserDefined": [],
      "ReferenceField": [
        {
          "Value": "Julie True",
          "Type": "Assigned Dispatcher",
          "PrintOnBOL": true,
          "PrintOnShippingLabel": false
        }
      ]
    }
  ],
  "Errors": [],
  "Success": true
}
Modified at 2024-09-16 11:42:17
Previous
DispatchLoad
Next
GetNotes
Built with