GetNotes - Banyan Technology LIVE Connect™

Used to retrieve shipment notesUsed for retrieving information on shipments and invoices.

Request

Header Params

string

required

Example:

application/json

Body Params application/json

AuthenticationData

object (Authentication Data)

required

Banyan Credentials

Username

string

required

Banyan Username

Password

string

required

Banyan Password

ClientRefNum

string | null

optional

Client Reference Number - Used during multiple client integrations

LoadId

integer

required

Banyan's primary Shipment Identifier

Example

{
  "AuthenticationData": {
    "Username": "",
    "Password": "",
    "ClientRefNum": ""
  },
  "LoadId": 36887370
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200GetNotes

application/json

Body

Notes

array[object (Note) {4}]

required

Shipment & carrier notes

Text

string

required

Note text

User

string

required

Note creator

DateStamp

string

required

Note date

NoteType

enum<string>

required

Note Type

Allowed values:

AccountingAdjustmentEmailArchivingQuoteUpdateCarrierAwardedQuoteTechnicalNoteWebTrackingEdiSystemEventInstructionsPublicBookReasonWebDispatchQuoteRequestPrivateContactAccountingTerminalUrlCustomerDockUpdateAddressDeleteQuotePackageRateExceptionBillingReasonAdditionalServiceValidationQuoteQuoteRequestEmail

Errors

array[string]

required

Success

boolean

required

Whether request was successful

Example

{
  "Notes": [
    {
      "Text": "Auto Book Failure. Email Sent: True",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:54",
      "NoteType": 7
    },
    {
      "Text": "Web Dispatch Failed: &nbsp;&nbsp;•Consignee Contact Name Required &nbsp;&nbsp;•Consignee Phone Number Required &nbsp;&nbsp;•Shipper Contact Name Required &nbsp;&nbsp;•Shipper Phone Number Required",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:54",
      "NoteType": 14
    },
    {
      "Text": "Dayton Freight Standard: Pickup Request Failed.",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:54",
      "NoteType": 7
    },
    {
      "Text": "Web Dispatch Error returned: </br>Friendly Error: Shipper Phone Number Required</br>Error: Shipper Phone Number Required",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:54",
      "NoteType": 7
    },
    {
      "Text": "Web Dispatch Error returned: </br>Friendly Error: Consignee Phone Number Required</br>Error: Consignee Phone Number Required",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:54",
      "NoteType": 7
    },
    {
      "Text": "Web Dispatch Error returned: </br>Friendly Error: Shipper Contact Name Required</br>Error: Shipper Contact Name Required",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:54",
      "NoteType": 7
    },
    {
      "Text": "Web Dispatch Error returned: </br>Friendly Error: Consignee Contact Name Required</br>Error: Consignee Contact Name Required",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:54",
      "NoteType": 7
    },
    {
      "Text": "Overrides: - Billing",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:11",
      "NoteType": 7
    },
    {
      "Text": "LoadID:36887370 BolNum: QuoteID:330903366 ManifestID: ActualCharge:120.23 PickupDate:10/28/2021 AccessTime:00:00 CarrierID:7459 Web_Dispatch:True EDI_Dispatch:False",
      "User": "Eric Intihar",
      "DateStamp": "2021-10-28T13:43:11",
      "NoteType": 7
    },
    {
      "Text": "",
      "User": "Eric Intihar",
      "DateStamp": "2021-10-28T13:43:11",
      "NoteType": 22
    },
    {
      "Text": "Load booked with Dayton Freight Standard.",
      "User": "Eric Intihar",
      "DateStamp": "2021-10-28T13:43:11",
      "NoteType": 10
    },
    {
      "Text": "<a href=javascript:ShowTerminalLink('7459','36887370')>Terminal Link</a>",
      "User": "Eric Intihar",
      "DateStamp": "2021-10-28T13:43:11",
      "NoteType": 19
    },
    {
      "Text": "Awarded quote email was not sent due to permissions.",
      "User": "Eric Intihar",
      "DateStamp": "2021-10-28T13:43:11",
      "NoteType": 7
    },
    {
      "Text": "Original shipperDateTime = 10/28/2021 Original consigneedatetime = 10/28/2021 New shipperDateTime = 10/28/2021 New consigneedatetime = 10/29/2021 ActualPickupDate = 10/28/2021 ActualDeliverDate = 10/29/2021",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:43:11",
      "NoteType": 7
    },
    {
      "Text": "Override for 6629252 - Dayton Freight Standard<br />- Billing",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:42:16",
      "NoteType": 7
    },
    {
      "Text": "Load Created",
      "User": "Eric Intihar",
      "DateStamp": "2021-10-28T13:41:31",
      "NoteType": 10
    },
    {
      "Text": "Original BOLID: BWS2130100010",
      "User": "Automation",
      "DateStamp": "2021-10-28T13:41:31",
      "NoteType": 7
    }
  ],
  "Errors": [],
  "Success": true
}