Banyan Technology LIVE Connect™
  1. StaticData
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
        GET
      • Document Types
        GET
      • Equipment Types
        GET
      • Package Types
        GET
      • Limited Access Types
        GET
      • Size UOMs
        GET
      • Weight UOMs
        GET
      • Pay Types
        GET
      • Ship Types
        GET
      • Countries
        GET
      • Statuses
        GET
      • Service Modes
        GET
  • 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. StaticData

Accessorials

GET
/api/StaticData/Accessorials
StaticData
Returns a list of all available Accessorials.
When supplying Accessorials to the Create or Update Shipment methods, only the description or abbreviation is required.
 "loadAccessorials" : [{
     "description": "Guaranteed"
 }]

 or
 
 "loadAccessorials" : [{
     "abbreviation": "LGUAR"
 }]
typeDescription
LoadThe accessorial will or should be included in the loadAccessorials collection.
ShipperThe accessorial will or should be included in the shipperAccessorials collection.
ConsigneeThe accessorial will or should be included in the consigneeAccessorials collection.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

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 GET 'https://ws.integration.banyantechnology.com/api/StaticData/Accessorials'

Responses

🟢200Success
application/json
Body
Contains information on accessorials to a user Inherits from StaticDto and adds relevant data to create an accessorialDto
description
string 
optional
The full name of the item.
type
string 
optional
Represents the type that the accessorials is. Load, Shipper, consignee, or mandatory
abbreviation
string 
optional
The abbreviation that can be used for the accessorial.
Example
[
  {
    "type": "Consignee",
    "abbreviation": "CAPPT",
    "description": "Appointment Required"
  },
  {
    "type": "Consignee",
    "abbreviation": "CCARR",
    "description": "Carrier Hub Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "CCOMM",
    "description": "Commercial Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "DELNO",
    "description": "Deliver Notification"
  },
  {
    "type": "Consignee",
    "abbreviation": "CIDEL",
    "description": "Inside Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "CLFTG",
    "description": "Liftgate Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "CMARK",
    "description": "Marking and Tagging"
  },
  {
    "type": "Consignee",
    "abbreviation": "CNBD",
    "description": "Non-Business Hours Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "CNYCM",
    "description": "NYC Metro"
  },
  {
    "type": "Consignee",
    "abbreviation": "CJACK",
    "description": "Pallet Jack"
  },
  {
    "type": "Consignee",
    "abbreviation": "CRDEL",
    "description": "Residential Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "CSHIP",
    "description": "Shipper Hub Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "CSORT",
    "description": "Sort and Segregate"
  },
  {
    "type": "Consignee",
    "abbreviation": "LTDEL",
    "description": "Trade Show Delivery"
  },
  {
    "type": "Consignee",
    "abbreviation": "THD",
    "description": "Two Hour Special Delivery"
  },
  {
    "type": "Load",
    "abbreviation": "SMAN",
    "description": "2nd Man"
  },
  {
    "type": "Load",
    "abbreviation": "AGE",
    "description": "Age Restricted"
  },
  {
    "type": "Load",
    "abbreviation": "LBIND",
    "description": "Binders"
  },
  {
    "type": "Load",
    "abbreviation": "LBSCH",
    "description": "Blanket Service - Chilled"
  },
  {
    "type": "Load",
    "abbreviation": "LBSFZ",
    "description": "Blanket Service - Frozen"
  },
  {
    "type": "Load",
    "abbreviation": "LBSHP",
    "description": "Blind Shipment"
  },
  {
    "type": "Load",
    "abbreviation": "BLKHD",
    "description": "Bulkhead"
  },
  {
    "type": "Load",
    "abbreviation": "LCHAI",
    "description": "Chains Required"
  },
  {
    "type": "Load",
    "abbreviation": "COD",
    "description": "COD"
  },
  {
    "type": "Load",
    "abbreviation": "CURB",
    "description": "Curb"
  },
  {
    "type": "Load",
    "abbreviation": "LBOND",
    "description": "Customs In-Bond"
  },
  {
    "type": "Load",
    "abbreviation": "DL",
    "description": "Declared Liability"
  },
  {
    "type": "Load",
    "abbreviation": "LEXPD",
    "description": "Expedited"
  },
  {
    "type": "Load",
    "abbreviation": "LFGP",
    "description": "Food Grade Products"
  },
  {
    "type": "Load",
    "abbreviation": "LGUAR",
    "description": "Guaranteed"
  },
  {
    "type": "Load",
    "abbreviation": "LHDEL",
    "description": "Holiday Delivery"
  },
  {
    "type": "Load",
    "abbreviation": "LHPCK",
    "description": "Holiday Pickup"
  },
  {
    "type": "Load",
    "abbreviation": "ASSEM",
    "description": "Light Assembly"
  },
  {
    "type": "Load",
    "abbreviation": "LSTRA",
    "description": "Must Be Strapped"
  },
  {
    "type": "Load",
    "abbreviation": "NOSG",
    "description": "No Signature"
  },
  {
    "type": "Load",
    "abbreviation": "LODIM",
    "description": "Over Dimension"
  },
  {
    "type": "Load",
    "abbreviation": "PRORE",
    "description": "Proactive Response"
  },
  {
    "type": "Load",
    "abbreviation": "LBSRV",
    "description": "Protect from Freezing"
  },
  {
    "type": "Load",
    "abbreviation": "RESDE",
    "description": "Restricted Delivery"
  },
  {
    "type": "Load",
    "abbreviation": "RETRE",
    "description": "Return Receipt"
  },
  {
    "type": "Load",
    "abbreviation": "ROCH",
    "description": "Room of Choice"
  },
  {
    "type": "Load",
    "abbreviation": "SATDE",
    "description": "Saturday Delivery"
  },
  {
    "type": "Load",
    "abbreviation": "SHLD",
    "description": "Shipment Hold"
  },
  {
    "type": "Load",
    "abbreviation": "SHIRE",
    "description": "Shipper Release"
  },
  {
    "type": "Load",
    "abbreviation": "SIGRQ",
    "description": "Signature Required"
  },
  {
    "type": "Load",
    "abbreviation": "LSING",
    "description": "Single Shipment"
  },
  {
    "type": "Load",
    "abbreviation": "SPEHA",
    "description": "Special Handling"
  },
  {
    "type": "Load",
    "abbreviation": "LSTAC",
    "description": "Stackable"
  },
  {
    "type": "Load",
    "abbreviation": "LSTAK",
    "description": "Stakes Required"
  },
  {
    "type": "Load",
    "abbreviation": "LTEDR",
    "description": "Tanker Endorsed Driver Required"
  },
  {
    "type": "Load",
    "abbreviation": "THRS",
    "description": "Threshold"
  },
  {
    "type": "Load",
    "abbreviation": "LTIME",
    "description": "Time Definite"
  },
  {
    "type": "Load",
    "abbreviation": "LTSA",
    "description": "TSA"
  },
  {
    "type": "Load",
    "abbreviation": "LTKEY",
    "description": "Turnkey"
  },
  {
    "type": "Load",
    "abbreviation": "LPSLA",
    "description": "Unattended"
  },
  {
    "type": "Load",
    "abbreviation": "LVSHP",
    "description": "Volume Shipment"
  },
  {
    "type": "Load",
    "abbreviation": "LWDET",
    "description": "Weight Determination"
  },
  {
    "type": "Load",
    "abbreviation": "WGLV",
    "description": "White Glove"
  },
  {
    "type": "Shipper",
    "abbreviation": "SAPPT",
    "description": "Appointment Required"
  },
  {
    "type": "Shipper",
    "abbreviation": "SCARR",
    "description": "Carrier Hub Pickup"
  },
  {
    "type": "Shipper",
    "abbreviation": "SCOMM",
    "description": "Commercial Pickup"
  },
  {
    "type": "Shipper",
    "abbreviation": "SIPCK",
    "description": "Inside Pickup"
  },
  {
    "type": "Shipper",
    "abbreviation": "SLFTG",
    "description": "Liftgate Pickup"
  },
  {
    "type": "Shipper",
    "abbreviation": "SMARK",
    "description": "Marking and Tagging"
  },
  {
    "type": "Shipper",
    "abbreviation": "SNBP",
    "description": "Non-Business Hours Pickup"
  },
  {
    "type": "Shipper",
    "abbreviation": "SNYCM",
    "description": "NYC Metro"
  },
  {
    "type": "Shipper",
    "abbreviation": "SJACK",
    "description": "Pallet Jack"
  },
  {
    "type": "Shipper",
    "abbreviation": "SRPCK",
    "description": "Residential Pickup"
  },
  {
    "type": "Shipper",
    "abbreviation": "SSHIP",
    "description": "Shipper Hub Pickup"
  },
  {
    "type": "Shipper",
    "abbreviation": "SSORT",
    "description": "Sort and Segregate"
  },
  {
    "type": "Shipper",
    "abbreviation": "LTPCK",
    "description": "Trade Show Pickup"
  }
]
🟠401Unauthorized
🟠403Forbidden
🟠429Too Many Requests
Modified at 2024-09-16 11:42:17
Previous
Mark as exported.
Next
Document Types
Built with