Banyan Technology LIVE Connect™
  1. Creating
Banyan Technology LIVE Connect™
  • Version 3
    • Authentication
      • Retrieve a token
    • Shipments
      • Creating
        • Create a Full Shipment
          POST
        • Create an EZ Rate Shipment
          POST
      • 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. Creating

Create a Full Shipment

POST
/api/v3/shipments

Create a full shipment in Banyan.#

A full shipment contains all of the required information to quote and optionally book the shipment.
To retrieve our up to date enum values (accessorials, equipment types etc...) please use our static data endpoints.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
The Create Shipment request.
waitForRates
boolean 
optional
Only neccessary for creating shipments in Quoted Status.
True, if the the system should wait for the rating process to complete before returning a response, otherwise a response will be returned immediatly and quotes will need to be manually retrieved.
Default:
true
importAsStatus
enum<string> 
required
The status the shipment should be imported as.
Allowed values:
PendingQuotedBookedDispatched
isEzRate
boolean 
optional
True if this should be imported as an EZ Rate, otherwise false. EZ Rate shipments will have less required fields than a full shipment.
Default:
false
shouldRunRates
boolean 
optional
True, if the system should run rates through the carrier engine when quoting, otherwise false. If creating a shipment in Quoted status, this must be true, or a manual quote must be provided.
Default:
true
shipmentData
object (BanyanWebServices.Domain.Dtos.CreateShipment.ShipmentDataDto) 
required
The ShipmentData data transfer object. This will contain all relevant information about a shipment.
manifestId
string  | null 
optional
The manifest id. May also be referred to as the PRO Number.
<= 50 characters
bolNumber
string  | null 
optional
The Bill of Lading number.
<= 1000 characters
customerPo
string  | null 
optional
The customer PO number.
<= 1000 characters
invoiceId
string  | null 
optional
The invoice id.
<= 1000 characters
billingId
string  | null 
optional
The billing id.
<= 1000 characters
shipperConfirmationNumber
string  | null 
optional
The shipper pickup number.
<= 50 characters
consigneeConfirmationNumber
string  | null 
optional
The consignee pickup number.
<= 50 characters
estimatedPickup
string <date-time>
optional
The estimated pickup date.
actualPickup
string <date-time>
optional
The actual pickup date.
estimatedDelivery
string <date-time>
optional
The estimated delivery date.
actualDelivery
string <date-time>
optional
The actual delivery date.
shipType
enum<string> 
required
The shipping type.
Allowed values:
ShipperConsigneeThirdParty
payType
enum<string> 
required
The pay type
Allowed values:
CollectPrepaid
exportReason
enum<string> 
optional
The International export reason.
Allowed values:
TemporaryRepair/ReturnPermanent
internationalTerm
enum<string> 
optional
The international terms.
Allowed values:
Cost and FreightCost Insurance and FreightCarriage and Insurance PaidCarriage Paid ToDelivered at FrontierDelivered Duty PaidDelivered Duty UnpaidDelivered Ex QuayDelivered Ex ShipEx WorksFree Alongside ShipFree CarrierFree On Board
usBrokerSameAsShipper
boolean 
optional
Flag to set us broker values to the same as the shipper.
Default:
false
usBrokerSameAsConsignee
boolean 
optional
Flag to set US broker values to the same as the consignee.
Default:
false
internationalBrokerSameAsShipper
boolean 
optional
Flag to set Int. broker values to the same as the shipper.
Default:
false
internationalBrokerSameAsConsignee
boolean 
optional
Flag to set Int. broker values to the same as the consignee.
Default:
false
useDefaultUSBroker
boolean 
optional
Flag to set US broker values to the clients default US broker
Default:
false
useDefaultInternationalBroker
boolean 
optional
Flag to set Int. broker values to the clients default Int. broker
Default:
false
usBroker
object (BrokerDto) 
optional
US broker details
internationalBroker
object (BrokerDto) 
optional
International broker details
shipperLocation
object (LocationDto) 
required
Shipper Information
consigneeLocation
object (LocationDto) 
required
Consignee Information
useDefaultBillTo
boolean 
optional
Gets or sets a flag indicating whether default bill to data should be used.
If set to true, the BillTo section of the request should be left null and the system will load defaults.
If set to false, the BillTo section of the request must be provided.
Default:
false
billTo
object (BillToDto) 
optional
BillTo information. Required if useDefaultBillTo is false.
shipmentServices
array[object (ShipmentServiceDto) {8}] 
required
The shipment services.
>= 1 items
packageInfo
object (PackageInfoDto) 
optional
Package Information
insuranceInfo
object (BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto) 
optional
Shipment Insurance
handlingUnits
array[object (HandlingUnitDto) {9}] 
required
The handling units containing product information.
For shipments that cannot utilize handling units, supply a single handling unit with 0 for quantity, and None for package type, and the shipment will not create handling units.
>= 1 items
documents
array[object (DocumentPostDto) {4}] 
optional
referenceFields
array[object (ReferenceFieldDto) {4}]  | null 
optional
The reference fields. These relate to custom reference fields set up on a client basis.
shipperAccessorials
array[object (ShipperAccessorialDto) {3}]  | null 
optional
The shipper (origin) accessorials. Only one of abbreviation or description is required when supplying accessorials.
consigneeAccessorials
array[object (ConsigneeAccessorialDto) {3}]  | null 
optional
The consignee (destination) accessorials. Only one of abbreviation or description is required when supplying accessorials.
loadAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The shipment accessorials. Only one of abbreviation or description is required when supplying accessorials.
pullMarketRates
boolean 
optional
True, if Market Rates should be retrieved for this shipment. This requires account configuration in the Banyan Platform.
Default:
false
requestCarbonService
boolean 
optional
If true, When creating and rating a shipment, the system will request a carbon footprint calculation
and estimate for the cost of offset. If the shipment is going to booked or further status, the offset will be purchased
if the user has permission to do so. If false no additional processing occurs.
Default:
false
manualQuoteData
object (ManualQuoteDto)  | null 
optional
Manual quote information, required when not using the rating engine.
carrierCharge
number <double>
optional
Quote's carrier pricing amount
customerCharge
number <double>
optional
Quote's customer pricing amount
totalPrice
number <double>
required
Quote total charge amount
interline
boolean 
required
Set to true only when confirmed to be interline
currency
enum<string> 
required
Quote's currency
Allowed values:
USDollarCanadianDollarMexicanPeso
miles
integer <int32>
optional
Quote's mileage amount
transitTimeDays
integer <int32>
optional
Quote's assigned transit time in days
note
string 
optional
Quote Note
discountAmount
number <double>
optional
Quote discount amount
freightCharge
number <double>
optional
Quote freight charge amount
fuelSurcharge
number <double>
optional
Quote fuel surcharge amount
carrierScac
string 
optional
If the shipment is going to booked status or further, the SCAC related to the carrier the shipment should book under.
quoteNumber
string 
optional
The Quote Number to use when creating a manual quote.
submitPickupRequest
boolean 
optional
If the shipment is going to dispatched status, this flag indicates whether a pickup request is submitted to the carrier. If this is false, no communication will be sent to the carrier.
Default:
false
dispatchOverride
boolean 
optional
If the shipment is going to dispatched status, this flag indicates the status should change even if the dispatch request fails.
Default:
false
emailBol
boolean 
optional
If the shipment is going to dispatched status, this flag indicates that a copy of the BOL should be sent to the supplied email addresses.
Default:
false
bolEmailAddress
string 
optional
A comma separated list of email addresses to send BOL copies to. This field is required if emailBol is set to true.
Example
{
    "importAsStatus": "Quoted",
    "shouldRunRates": true,
    "isEzRate": true,
    "waitForRates": false,
    "shipmentData": {
        "shipType": "ThirdParty",
        "payType": "Prepaid",
        "shipperLocation": {
            "address": {
                "city": "ALBANY",
                "stateOrProvince": "NY",
                "zipCode": "12204",
                "country": "United States"
            }
        },
        "consigneeLocation": {
            "address": {
                "city": "MIAMI",
                "stateOrProvince": "FL",
                "zipCode": "33156",
                "country": "United States"
            }
        },
        "shipmentServices": [
            {
                "serviceMode": "LTL",
                "quantity": 1,
                "packageType": "Pallets",
                "equipmentType": "Van-Standard Trailer",
                "weightUnitOfMeasurement": "LBS"
            }
        ],
        "handlingUnits": [
            {
                "packageType": "Pallets",
                "quantity": 1,
                "products": [
                    {
                        "packageType": "Boxes",
                        "quantity": 10,
                        "class": 200,
                        "weight": 210,
                        "weightUnitOfMeasurement": "LBS",
                        "dimensions": {
                            "unitOfMeasurement": "IN",
                            "length": 42,
                            "width": 42,
                            "height": 56
                        },
                        "description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
                    }
                ]
            }
        ]
    }
}

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/api/v3/shipments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "importAsStatus": "Quoted",
    "shouldRunRates": true,
    "isEzRate": true,
    "waitForRates": false,
    "shipmentData": {
        "shipType": "ThirdParty",
        "payType": "Prepaid",
        "shipperLocation": {
            "address": {
                "city": "ALBANY",
                "stateOrProvince": "NY",
                "zipCode": "12204",
                "country": "United States"
            }
        },
        "consigneeLocation": {
            "address": {
                "city": "MIAMI",
                "stateOrProvince": "FL",
                "zipCode": "33156",
                "country": "United States"
            }
        },
        "shipmentServices": [
            {
                "serviceMode": "LTL",
                "quantity": 1,
                "packageType": "Pallets",
                "equipmentType": "Van-Standard Trailer",
                "weightUnitOfMeasurement": "LBS"
            }
        ],
        "handlingUnits": [
            {
                "packageType": "Pallets",
                "quantity": 1,
                "products": [
                    {
                        "packageType": "Boxes",
                        "quantity": 10,
                        "class": 200,
                        "weight": 210,
                        "weightUnitOfMeasurement": "LBS",
                        "dimensions": {
                            "unitOfMeasurement": "IN",
                            "length": 42,
                            "width": 42,
                            "height": 56
                        },
                        "description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
                    }
                ]
            }
        ]
    }
}'

Responses

🟢201Created
application/json
Body
Class ShipmentDto.
loadId
integer <int32>
required
Banyan's primary shipment identifier
status
enum<string> 
required
Description of current status
Allowed values:
PendingOpenQuotedBookedDispatchedIn TransitDeliveredCancelledDispatch RequestedDispatch FailedQuote Approval PendingApproval Denied
client
object (ClientDto) 
required
Client information for this shipment.
clientId
integer <int32>
optional
The unique id of this client in the Banyan system.
clientName
string  | null 
optional
Name of client that the shipment is under.
clientRefNumber
string  | null 
optional
The client ref number associated to this client.
awardedQuotePricing
object (AwardedQuotePricingDto) 
optional
Information about the awarded quote once a shipment has been booked.
raw
number <double>
optional
Quote raw price (returned from the carrier)
carrier
number <double>
optional
Quote carrier price (carrier markups applied)
customer
number <double>
optional
Quote customer price (customer markups applied)
quotes
array[object (QuoteDto) {21}]  | null 
optional
Gets or sets the quotes.
quoteId
integer <int32>
optional
Banyan's primary quote identifier
carrierName
string 
optional
Carrier name
carrierId
integer <int32>
optional
Banyan's primary carrier identifier
scac
string 
optional
Carrier standard carrier alpha code
thirdPartyName
string  | null 
optional
Typically set when the quote is from a 3PL. This will contain the 3pl carrier's name.
thirdPartyScac
string  | null 
optional
3PL standard carrier alpha code
serviceId
string  | null 
optional
Quote service identifier
rawPrice
object (QuotePriceDto) 
optional
Quote raw price (returned from the carrier)
carrierPrice
object (QuotePriceDto) 
optional
Quote carrier price (carrier markups applied)
customerPrice
object (QuotePriceDto) 
optional
Quote customer price (customer markups applied)
transitTime
integer <int32>
optional
Quote transit time
quoteNumber
string  | null 
optional
Carrier quote identifier
carrierPerson
string  | null 
optional
Carrier person
carrierNote
string  | null 
optional
Note returned by the carrier regarding the quote
dateStamp
string <date-time>
optional
Quote date
interline
boolean 
optional
Set to true only when confirmed to be interline
accepted
boolean 
optional
Quote has been accepted by client
currencyType
optional
Quote currency type
service
string  | null 
optional
Quote service
insuranceDetails
optional
Insurance Details related to the quote
accountNumber
string  | null 
optional
Account Number/ID used for Quote (if any)
notes
array[object (NoteDto) {4}]  | null 
optional
Shipment & carrier notes
description
string  | null 
optional
Note text
noteTypeId
integer <int32>
optional
Note Type Id
userName
string  | null 
optional
Note creator
dateStamp
string <date-time>
optional
Note date
manifestId
string  | null 
optional
Shipment PRO number
bolNumber
string  | null 
optional
Shipment BOL number
customerPo
string  | null 
optional
Shipment Customer PO
invoiceId
string  | null 
optional
Shipment Invoice identifier
billingId
string  | null 
optional
Shipment Billing identifier
incoTermId
integer <int32>
optional
Shipment IncoTerm identifier
pickupNumber
string  | null 
optional
Pickup number assigned to the load
shipperConfirmationNumber
string  | null 
optional
Gets or sets the shipper confirmation number.
consigneeConfirmationNumber
string  | null 
optional
Gets or sets the consignee confirmation number.
estimatedPickup
string <date-time> | null 
optional
Estimated Pickup Date
actualPickup
string <date-time> | null 
optional
Actual Pickup Date
estimatedDelivery
string <date-time> | null 
optional
Estimated Delivery Date
actualDelivery
string <date-time> | null 
optional
Actual Delivery Date
createdDate
string <date-time> | null 
optional
Shipment created date
shipType
enum<string> 
required
Shipment Ship Type
Allowed values:
ShipperConsigneeThirdParty
payType
enum<string> 
required
Shipment Pay Type
Allowed values:
CollectPrepaid
exportReason
string  | null 
optional
Gets or sets the Export Reason.
internationalTerm
string  | null 
optional
Gets or sets the International Term.
shipperLocation
object (LocationDto) 
optional
Shipper Information
companyName
string  | null 
optional
Company name
<= 50 characters
locationName
string  | null 
optional
Location name
<= 50 characters
einNumber
string  | null 
optional
The EIN Number of the location (if applicable)
<= 10 characters
note
string  | null 
optional
A note for the location
<= 1000 characters
contactMethods
object (ContactMethodsDto) 
optional
Contact methods for the location.
contactPerson
object (ContactPersonDto) 
optional
Contact Person for the location
address
object (AddressDto) 
optional
Address information for the location.
vendorId
string  | null 
optional
Vendor identifier - Used to map to an existing vendor in Banyan.
The system will look up the vendor location and use that data instead of what is in the request.
<= 50 characters
distributionCenterReferenceNumber
string  | null 
optional
Distribution center identifier - Used to map to an existing distribution center in Banyan. This can further filter data for vendors with multiple locations.
<= 50 characters
dock
object (DockDetailsDto)  | null 
optional
Dock Information for the location.
consigneeLocation
object (LocationDto) 
optional
Consignee Information
billTo
object (BillToDto) 
optional
Billing Information
name
string  | null 
optional
Name of Bill To
<= 50 characters
contactMethods
object (ContactMethodsDto) 
optional
Bill To contact methods
note
string  | null 
optional
Note for Bill To
<= 1000 characters
address
object (AddressDto) 
optional
Bill To Address information
packageInfo
object (PackageInfoDto) 
optional
Package Information
routeNumber
string  | null 
optional
Used to identify the route a driver will take when moving a package; used for Local Carrier
cod
number <double>
optional
Shipment collect on delivery amount
>= 0
declaredLiability
number <double>
optional
Shipment declared liability amount
>= 0
shipmentServices
array[object (ShipmentServiceDto) {8}]  | null 
optional
Shipment Service(s)
serviceMode
enum<string> 
required
The service mode of the shipment. Default: LTL
Allowed values:
Standard Parcel ServiceLTLVolumeAir CargoOcean FreightDrive AwayIntermodalOcean LCLAir InternationalInternational ExpeditedDomestic ExpeditedFull TruckloadBulkRailDrayageLocal CarrierExpeditedScheduledPartial TruckloadGFPSpot QuoteFinal Mile
quantity
integer <int32>
optional
Shipment shipping quantity
> 0
packageType
enum<string> 
required
The package type of the shipment. Default: Pallets
Allowed values:
ACCATTBAGSBALEBRRLBASKBINBOXSBUCKBHDSBNDLCARBCRTNCASECHSTCOILCTNCRTSCYLSDRUMEACHENVLPFEETFIRKGYLDKEGSLOOSOCTAPACKPAILPLTSPIECPCJCRACKREELROLLSKIDSLIPSPRSTOTETRLRTRYSTRCKTRNKTUBETUBSUNITSUNPKVHCL
equipmentType
enum<string> 
required
The equipment type of the shipment. Default: Van-standard trailer
Allowed values:
16ft Straight Truck18ft Straight Truck24ft Straight Truck24ft Straight Truck w/ lift gate26ft Straight Truck26ft Straight Truck w/ lift gate4x453ft - Van TrailerAir CargoALLBox truckBox truck w/ lift gateBulk TruckCarCar-CarrierCargo VanContainer - 20ftContainer - 40ftContainer - 40HQContainer - 45ftContainer - 53ftDouble DropDoublesDump TruckDumper - 20 yardDumper - 40 yardDumper - 60 yardDumper - 80 yardFlat BedFrozenFull Size VanGooseneckHopper BottomLow BoyMaxi TrailerMinivanOtherParcel TruckPickup TruckRail Car - 20ftRail Car - 40ftRail Car - 53ftRefrigeratedRemovable GooseneckRoll-off TruckSprinter VanStep DeckTankerTractorTractor TrailerTrailer – 24ftTrailer – 26ftTrailer – 28ftTrailer – 48ftTrailer – 53ftTri-Axle VanTruckTruck w/ lift gateVanVan w/ lift gateVan-standard trailerWalking FloorWinch Truck
additionalWeight
number <double>
optional
Shipment additional weight
>= 0
weightUnitOfMeasurement
optional
The weight unit of measurement for the shipment. Default: LBS
specialInstructions
string  | null 
optional
Shipment special instructions
<= 1000 characters
dimensions
object (DimensionsDto) 
optional
Total shipment dimenstions
handlingUnits
array[object (HandlingUnitDto) {9}]  | null 
optional
The handling units containing product information.
packageType
enum<string> 
required
The package type for the handling unit. Pallets is the default value.
Allowed values:
ACCATTBAGSBALEBRRLBASKBINBOXSBUCKBHDSBNDLCARBCRTNCASECHSTCOILCTNCRTSCYLSDRUMEACHENVLPFEETFIRKGYLDKEGSLOOSOCTAPACKPAILPLTSPIECPCJCRACKREELROLLSKIDSLIPSPRSTOTETRLRTRYSTRCKTRNKTUBETUBSUNITSUNPKVHCL
quantity
integer <int32>
optional
The quanity of this hanlding unit.
length
number <double>
optional
The Length of the handling unit.
width
number <double>
optional
The width of the handling unit.
height
number <double>
optional
The height of the handling unit.
additionalWeight
number <double>
optional
Any additional weight added to the handling unit.
unitOfMeasurement
enum<string> 
optional
The unit of measurement for the size dimensions of the handling unit. Required if dimensions are provided.
Allowed values:
CMFTIN
weightUnitOfMeasurement
enum<string> 
optional
The unit of measurement for the Additional Weight of the handling unit.
Allowed values:
LBSKG
products
array[object (ProductDto) {13}] 
required
The individual products on the handling unit.
>= 1 items
loadAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The shipment accessorials.
description
enum<string> 
optional
The full description of the accessorial
Allowed values:
Age RestrictedLight AssemblyBulkheadBindersCustoms In-BondBlanket Service - ChilledBlanket Service - FrozenBlind ShipmentProtect from FreezingChains RequiredExpeditedFood Grade ProductsGuaranteedHoliday DeliveryHoliday PickupOver DimensionUnattendedSingle ShipmentStackableStakes RequiredMust Be StrappedTanker Endorsed Driver RequiredTime DefiniteTurnkeyTSAVolume ShipmentWeight DeterminationNo SignatureProactive ResponseRestricted DeliveryReturn ReceiptRoom of ChoiceSaturday DeliveryShipper ReleaseShipment HoldSignature Required2nd ManSpecial HandlingThresholdWhite Glove
abbreviation
enum<string> 
optional
The abbreviation (code) of the accessorial
Allowed values:
AGE ASSEMBLKHDLBINDLBONDLBSCHLBSFZLBSHPLBSRVLCHAILEXPDLFGP LGUARLHDELLHPCKLODIMLPSLALSINGLSTACLSTAKLSTRALTEDRLTIMELTKEYLTSA LVSHPLWDETNOSG PRORERESDERETREROCH SATDESHIRESHLD SIGRQSMAN SPEHATHRS WGLV
value
string  | null 
optional
An optional value for the accessorial
shipperAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The shipper accessorials.
description
enum<string> 
optional
The full description of the accessorial
Allowed values:
Age RestrictedLight AssemblyBulkheadBindersCustoms In-BondBlanket Service - ChilledBlanket Service - FrozenBlind ShipmentProtect from FreezingChains RequiredExpeditedFood Grade ProductsGuaranteedHoliday DeliveryHoliday PickupOver DimensionUnattendedSingle ShipmentStackableStakes RequiredMust Be StrappedTanker Endorsed Driver RequiredTime DefiniteTurnkeyTSAVolume ShipmentWeight DeterminationNo SignatureProactive ResponseRestricted DeliveryReturn ReceiptRoom of ChoiceSaturday DeliveryShipper ReleaseShipment HoldSignature Required2nd ManSpecial HandlingThresholdWhite Glove
abbreviation
enum<string> 
optional
The abbreviation (code) of the accessorial
Allowed values:
AGE ASSEMBLKHDLBINDLBONDLBSCHLBSFZLBSHPLBSRVLCHAILEXPDLFGP LGUARLHDELLHPCKLODIMLPSLALSINGLSTACLSTAKLSTRALTEDRLTIMELTKEYLTSA LVSHPLWDETNOSG PRORERESDERETREROCH SATDESHIRESHLD SIGRQSMAN SPEHATHRS WGLV
value
string  | null 
optional
An optional value for the accessorial
consigneeAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The consignee accessorials.
description
enum<string> 
optional
The full description of the accessorial
Allowed values:
Age RestrictedLight AssemblyBulkheadBindersCustoms In-BondBlanket Service - ChilledBlanket Service - FrozenBlind ShipmentProtect from FreezingChains RequiredExpeditedFood Grade ProductsGuaranteedHoliday DeliveryHoliday PickupOver DimensionUnattendedSingle ShipmentStackableStakes RequiredMust Be StrappedTanker Endorsed Driver RequiredTime DefiniteTurnkeyTSAVolume ShipmentWeight DeterminationNo SignatureProactive ResponseRestricted DeliveryReturn ReceiptRoom of ChoiceSaturday DeliveryShipper ReleaseShipment HoldSignature Required2nd ManSpecial HandlingThresholdWhite Glove
abbreviation
enum<string> 
optional
The abbreviation (code) of the accessorial
Allowed values:
AGE ASSEMBLKHDLBINDLBONDLBSCHLBSFZLBSHPLBSRVLCHAILEXPDLFGP LGUARLHDELLHPCKLODIMLPSLALSINGLSTACLSTAKLSTRALTEDRLTIMELTKEYLTSA LVSHPLWDETNOSG PRORERESDERETREROCH SATDESHIRESHLD SIGRQSMAN SPEHATHRS WGLV
value
string  | null 
optional
An optional value for the accessorial
referenceFields
array[object (ReferenceFieldDto) {4}]  | null 
optional
The reference fields. These relate to custom reference fields set up on a client basis.
type
string 
required
The type of the Reference field
>= 1 characters<= 250 characters
value
string 
required
The actual value of the Reference field
>= 1 characters<= 250 characters
printOnBol
boolean 
optional
If true, this reference field will be printed on the shipments BOL
printOnShippingLabel
boolean 
optional
If true, this reference field will be printed on the shipments Shipping Label
insuranceInfo
object (BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto) 
optional
Shipment Insurance Details
vendor
string  | null 
optional
The vendor. This will match based on vendor name or code.
commodityType
string  | null 
optional
The commodity type. This will match based on name or code.
commodityCondition
string  | null 
optional
The commodity condition. This will match on name or code.
insuredValue
number <double> | null 
optional
The amount being insured.
stops
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {45}]  | null 
optional
Individual stops for a multi-stop shipment
loadId
integer <int32>
required
Banyan's primary shipment identifier
status
enum<string> 
required
Description of current status
Allowed values:
PendingOpenQuotedBookedDispatchedIn TransitDeliveredCancelledDispatch RequestedDispatch FailedQuote Approval PendingApproval Denied
client
object (ClientDto) 
required
Client information for this shipment.
awardedQuotePricing
object (AwardedQuotePricingDto) 
optional
Information about the awarded quote once a shipment has been booked.
quotes
array[object (QuoteDto) {21}]  | null 
optional
Gets or sets the quotes.
notes
array[object (NoteDto) {4}]  | null 
optional
Shipment & carrier notes
manifestId
string  | null 
optional
Shipment PRO number
bolNumber
string  | null 
optional
Shipment BOL number
customerPo
string  | null 
optional
Shipment Customer PO
invoiceId
string  | null 
optional
Shipment Invoice identifier
billingId
string  | null 
optional
Shipment Billing identifier
incoTermId
integer <int32>
optional
Shipment IncoTerm identifier
pickupNumber
string  | null 
optional
Pickup number assigned to the load
shipperConfirmationNumber
string  | null 
optional
Gets or sets the shipper confirmation number.
consigneeConfirmationNumber
string  | null 
optional
Gets or sets the consignee confirmation number.
estimatedPickup
string <date-time> | null 
optional
Estimated Pickup Date
actualPickup
string <date-time> | null 
optional
Actual Pickup Date
estimatedDelivery
string <date-time> | null 
optional
Estimated Delivery Date
actualDelivery
string <date-time> | null 
optional
Actual Delivery Date
createdDate
string <date-time> | null 
optional
Shipment created date
shipType
enum<string> 
required
Shipment Ship Type
Allowed values:
ShipperConsigneeThirdParty
payType
enum<string> 
required
Shipment Pay Type
Allowed values:
CollectPrepaid
exportReason
string  | null 
optional
Gets or sets the Export Reason.
internationalTerm
string  | null 
optional
Gets or sets the International Term.
shipperLocation
object (LocationDto) 
optional
Shipper Information
consigneeLocation
object (LocationDto) 
optional
Consignee Information
billTo
object (BillToDto) 
optional
Billing Information
packageInfo
object (PackageInfoDto) 
optional
Package Information
shipmentServices
array[object (ShipmentServiceDto) {8}]  | null 
optional
Shipment Service(s)
handlingUnits
array[object (HandlingUnitDto) {9}]  | null 
optional
The handling units containing product information.
loadAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The shipment accessorials.
shipperAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The shipper accessorials.
consigneeAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The consignee accessorials.
referenceFields
array[object (ReferenceFieldDto) {4}]  | null 
optional
The reference fields. These relate to custom reference fields set up on a client basis.
insuranceInfo
object (BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto) 
optional
Shipment Insurance Details
stops
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {45}]  | null 
optional
Individual stops for a multi-stop shipment
legs
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {45}]  | null 
optional
Individual legs for a multi-legshipment
exported
boolean 
optional
Gets or sets a value indicating whether this BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto is exported.
isMultiStop
boolean 
read-onlyoptional
Gets a value indicating whether this instance is multi stop.
isMultiLeg
boolean 
read-onlyoptional
Gets a value indicating whether this instance is multi leg.
dispatchResponse
object (BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto) 
optional
The standard dispatch response dto.
carbonQuote
object (BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto) 
optional
The carbon quote dto.
marketRates
array[object (BanyanWebServices.Domain.Dtos.Shipment.MarketRateDto) {8}]  | null 
optional
List of any MarketRates attached to a shipment
trackingNumbers
array[string]
required
List of any Tracking Numbers attached to a shipment
ratingCompleted
boolean 
required
Gets or sets a value indicating whether rating completed
legs
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {45}]  | null 
optional
Individual legs for a multi-legshipment
loadId
integer <int32>
required
Banyan's primary shipment identifier
status
enum<string> 
required
Description of current status
Allowed values:
PendingOpenQuotedBookedDispatchedIn TransitDeliveredCancelledDispatch RequestedDispatch FailedQuote Approval PendingApproval Denied
client
object (ClientDto) 
required
Client information for this shipment.
awardedQuotePricing
object (AwardedQuotePricingDto) 
optional
Information about the awarded quote once a shipment has been booked.
quotes
array[object (QuoteDto) {21}]  | null 
optional
Gets or sets the quotes.
notes
array[object (NoteDto) {4}]  | null 
optional
Shipment & carrier notes
manifestId
string  | null 
optional
Shipment PRO number
bolNumber
string  | null 
optional
Shipment BOL number
customerPo
string  | null 
optional
Shipment Customer PO
invoiceId
string  | null 
optional
Shipment Invoice identifier
billingId
string  | null 
optional
Shipment Billing identifier
incoTermId
integer <int32>
optional
Shipment IncoTerm identifier
pickupNumber
string  | null 
optional
Pickup number assigned to the load
shipperConfirmationNumber
string  | null 
optional
Gets or sets the shipper confirmation number.
consigneeConfirmationNumber
string  | null 
optional
Gets or sets the consignee confirmation number.
estimatedPickup
string <date-time> | null 
optional
Estimated Pickup Date
actualPickup
string <date-time> | null 
optional
Actual Pickup Date
estimatedDelivery
string <date-time> | null 
optional
Estimated Delivery Date
actualDelivery
string <date-time> | null 
optional
Actual Delivery Date
createdDate
string <date-time> | null 
optional
Shipment created date
shipType
enum<string> 
required
Shipment Ship Type
Allowed values:
ShipperConsigneeThirdParty
payType
enum<string> 
required
Shipment Pay Type
Allowed values:
CollectPrepaid
exportReason
string  | null 
optional
Gets or sets the Export Reason.
internationalTerm
string  | null 
optional
Gets or sets the International Term.
shipperLocation
object (LocationDto) 
optional
Shipper Information
consigneeLocation
object (LocationDto) 
optional
Consignee Information
billTo
object (BillToDto) 
optional
Billing Information
packageInfo
object (PackageInfoDto) 
optional
Package Information
shipmentServices
array[object (ShipmentServiceDto) {8}]  | null 
optional
Shipment Service(s)
handlingUnits
array[object (HandlingUnitDto) {9}]  | null 
optional
The handling units containing product information.
loadAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The shipment accessorials.
shipperAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The shipper accessorials.
consigneeAccessorials
array[object (ShipmentAccessorialDto) {3}]  | null 
optional
The consignee accessorials.
referenceFields
array[object (ReferenceFieldDto) {4}]  | null 
optional
The reference fields. These relate to custom reference fields set up on a client basis.
insuranceInfo
object (BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto) 
optional
Shipment Insurance Details
stops
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {45}]  | null 
optional
Individual stops for a multi-stop shipment
legs
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {45}]  | null 
optional
Individual legs for a multi-legshipment
exported
boolean 
optional
Gets or sets a value indicating whether this BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto is exported.
isMultiStop
boolean 
read-onlyoptional
Gets a value indicating whether this instance is multi stop.
isMultiLeg
boolean 
read-onlyoptional
Gets a value indicating whether this instance is multi leg.
dispatchResponse
object (BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto) 
optional
The standard dispatch response dto.
carbonQuote
object (BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto) 
optional
The carbon quote dto.
marketRates
array[object (BanyanWebServices.Domain.Dtos.Shipment.MarketRateDto) {8}]  | null 
optional
List of any MarketRates attached to a shipment
trackingNumbers
array[string]
required
List of any Tracking Numbers attached to a shipment
ratingCompleted
boolean 
required
Gets or sets a value indicating whether rating completed
exported
boolean 
optional
Gets or sets a value indicating whether this BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto is exported.
isMultiStop
boolean 
read-onlyoptional
Gets a value indicating whether this instance is multi stop.
isMultiLeg
boolean 
read-onlyoptional
Gets a value indicating whether this instance is multi leg.
dispatchResponse
object (BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto) 
optional
The standard dispatch response dto.
loadId
integer <int32>
optional
Gets or sets the load id.
success
boolean 
optional
Gets or sets a flag indicating if the dispatch request succeeded.
pickupNumber
string  | null 
optional
Gets or sets the pickup number.
carrierName
string  | null 
optional
Gets or sets the carrier name.
quoteNumber
string  | null 
optional
Gets or sets the quote number.
estimatedDeliveryDate
string <date-time> | null 
optional
Gets or sets the estimated delivery date.
proNumber
string  | null 
optional
Gets or sets the pro number.
userMessage
string  | null 
optional
Gets or sets the user message.
bolLink
string  | null 
optional
Gets or sets the BOL Link.
warnings
array[string] | null 
optional
Gets or sets the warnings.
errors
array[string] | null 
optional
Gets or sets a collection of error messages.
carbonQuote
object (BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto) 
optional
The carbon quote dto.
offsetAmount
number <double>
optional
The amount of carbon that will be offset in BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto.OffsetUnit.
offsetUnit
string  | null 
optional
The unit the BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto.OffsetAmount is in.
estimatedPrice
number <double>
optional
The estimated price of offsetting the carbon.
vendorFee
number <double>
optional
The vendor fee.
currency
string  | null 
optional
The currency monetary values are in.
orderId
string  | null 
optional
The order identifier.
marketRates
array[object (BanyanWebServices.Domain.Dtos.Shipment.MarketRateDto) {8}]  | null 
optional
List of any MarketRates attached to a shipment
vendorName
string  | null 
optional
Name of Vendor
highBuyRate
number <double> | null 
optional
High Buy Rate Recommendation of Vendor
lowBuyRate
number <double> | null 
optional
Low Buy Rate Recommendation of Vendor
buyRate
number <double> | null 
optional
Target Buy Rate Recommendation of Vendor
startRate
number <double> | null 
optional
Starting Bid Recommandation of Vendor
confidenceLevel
integer <int32> | null 
optional
Confidence of Vendor to hit target rate
currency
string  | null 
optional
The currency of the Market Rate.
date
string <date-time> | null 
optional
The date the Market Rate was generated.
trackingNumbers
array[string]
required
List of any Tracking Numbers attached to a shipment
ratingCompleted
boolean 
required
Gets or sets a value indicating whether rating completed
Example
{
    "loadId": 55349116,
    "status": "Quoted",
    "client": {
        "clientId": 45086,
        "clientName": "Banyan Web Services Test",
        "clientRefNumber": "BWSTO123"
    },
    "awardedQuotePricing": {
        "raw": 0,
        "carrier": 0,
        "customer": 0
    },
    "quotes": [
        {
            "quoteId": 448666865,
            "carrierName": "Banyan Test Carrier",
            "carrierId": 59742,
            "scac": "BTST",
            "thirdPartyName": "",
            "thirdPartyScac": "",
            "serviceId": "60204636",
            "rawPrice": {
                "netPrice": 1024,
                "freightCharge": 960.5,
                "discountAmount": 5,
                "fuelSurcharge": 15,
                "minimum": 0,
                "grossCharge": 965.5,
                "tariff": 0,
                "interline": 0,
                "accessorialCharges": 23.5,
                "otherCharges": 25,
                "charges": [
                    {
                        "name": "Construction Site (General)",
                        "amount": 25,
                        "code": "GCON"
                    },
                    {
                        "name": "Liftgate Delivery",
                        "amount": 2.5,
                        "code": "CLFTG"
                    },
                    {
                        "name": "Protect from Freezing",
                        "amount": 21,
                        "code": "LBSRV"
                    }
                ],
                "markup": 0
            },
            "carrierPrice": {
                "netPrice": 1094,
                "freightCharge": 1026.16,
                "discountAmount": 5.34,
                "fuelSurcharge": 16.03,
                "minimum": 0,
                "grossCharge": 1031.5,
                "tariff": 0,
                "interline": 0,
                "accessorialCharges": 25.11,
                "otherCharges": 26.71,
                "charges": [
                    {
                        "name": "Construction Site (General)",
                        "amount": 26.71,
                        "code": "GCON"
                    },
                    {
                        "name": "Liftgate Delivery",
                        "amount": 2.67,
                        "code": "CLFTG"
                    },
                    {
                        "name": "Protect from Freezing",
                        "amount": 22.44,
                        "code": "LBSRV"
                    }
                ],
                "markup": 6.84
            },
            "customerPrice": {
                "netPrice": 1302.8,
                "freightCharge": 1222.01,
                "discountAmount": 6.36,
                "fuelSurcharge": 19.08,
                "minimum": 0,
                "grossCharge": 1228.37,
                "tariff": 0,
                "interline": 0,
                "accessorialCharges": 29.9,
                "otherCharges": 31.81,
                "charges": [
                    {
                        "name": "Construction Site (General)",
                        "amount": 31.81,
                        "code": "GCON"
                    },
                    {
                        "name": "Liftgate Delivery",
                        "amount": 3.18,
                        "code": "CLFTG"
                    },
                    {
                        "name": "Protect from Freezing",
                        "amount": 26.72,
                        "code": "LBSRV"
                    }
                ],
                "markup": 27.23
            },
            "transitTime": 2,
            "quoteNumber": "1711044230",
            "carrierPerson": "Test Carrier Automated Quote",
            "carrierNote": "",
            "dateStamp": "2024-03-21T14:03:50",
            "interline": false,
            "accepted": false,
            "currencyType": "USDollar",
            "service": "LTL",
            "insuranceDetails": null,
            "accountNumber": "NewAccount"
        }
    ],
    "notes": [
        {
            "description": "Patch.IO carbon footprint: 100.093 kg\n Estimated offset cost: 0.48 USD",
            "noteTypeId": 18,
            "userName": "Shane Hawk",
            "dateStamp": "2024-03-21T14:03:49"
        },
        {
            "description": "No carbon project configured for your vendor. Patch.io will select a project.",
            "noteTypeId": 5,
            "userName": "Shane Hawk",
            "dateStamp": "2024-03-21T14:03:48"
        },
        {
            "description": "Load Created via Web Services 3.0",
            "noteTypeId": 10,
            "userName": "Shane Hawk",
            "dateStamp": "2024-03-21T14:03:47"
        }
    ],
    "manifestId": "qweqeqeqwewq",
    "bolNumber": "SampleBol",
    "customerPo": "customerPo",
    "invoiceId": "invoiceId",
    "billingId": "",
    "incoTermId": 0,
    "pickupNumber": null,
    "shipperConfirmationNumber": "",
    "consigneeConfirmationNumber": "",
    "estimatedPickup": "2023-06-30T00:00:00",
    "actualPickup": null,
    "estimatedDelivery": "2023-07-06T00:00:00",
    "actualDelivery": null,
    "createdDate": "2024-03-21T14:03:46",
    "shipType": "ThirdParty",
    "payType": "Prepaid",
    "exportReason": null,
    "internationalTerm": null,
    "shipperLocation": {
        "companyName": "s comp name",
        "locationName": "s loc name",
        "einNumber": null,
        "note": "",
        "contactMethods": {
            "phoneNumber": "1111111111",
            "extension": "",
            "faxNumber": "",
            "email": ""
        },
        "contactPerson": {
            "firstName": "",
            "lastName": ""
        },
        "address": {
            "lineOne": "123 main st",
            "lineTwo": "",
            "city": "ALBANY",
            "stateOrProvince": "NY",
            "zipCode": "12204",
            "country": "United States"
        },
        "vendorId": "43fffs",
        "distributionCenterReferenceNumber": "",
        "dock": {
            "name": "Main Dock",
            "note": "",
            "confirmationNumber": "",
            "openTime": "2023-06-30T09:00:00",
            "accessTime": "2023-06-30T13:00:00",
            "closeTime": "2023-06-30T16:00:00",
            "isFirstComeFirstServe": false,
            "limitedAccessType": ""
        }
    },
    "consigneeLocation": {
        "companyName": "c comp name",
        "locationName": "c loc name",
        "einNumber": null,
        "note": "",
        "contactMethods": {
            "phoneNumber": "33333333333",
            "extension": "",
            "faxNumber": "",
            "email": ""
        },
        "contactPerson": {
            "firstName": "",
            "lastName": ""
        },
        "address": {
            "lineOne": "123 main st",
            "lineTwo": "",
            "city": "MIAMI",
            "stateOrProvince": "FL",
            "zipCode": "33156",
            "country": "United States"
        },
        "vendorId": "",
        "distributionCenterReferenceNumber": "",
        "dock": {
            "name": "Main Dock",
            "note": "",
            "confirmationNumber": "",
            "openTime": "2023-07-06T09:00:00",
            "accessTime": "2023-07-06T09:00:00",
            "closeTime": "2023-07-06T16:00:00",
            "isFirstComeFirstServe": false,
            "limitedAccessType": ""
        }
    },
    "billTo": {
        "name": "Banyan Technology",
        "contactMethods": {
            "phoneNumber": "216-867-5309",
            "extension": "",
            "faxNumber": "",
            "email": "test@banyantechnology.com"
        },
        "note": "",
        "address": {
            "lineOne": "30505 Clemens Rd",
            "lineTwo": "",
            "city": "Westlake",
            "stateOrProvince": "OH",
            "zipCode": "44145",
            "country": "United States"
        }
    },
    "packageInfo": {
        "routeNumber": "",
        "cod": 0,
        "declaredLiability": 0
    },
    "shipmentServices": [
        {
            "serviceMode": "LTL",
            "quantity": 1,
            "packageType": "CRTN",
            "equipmentType": "DV",
            "additionalWeight": 0,
            "weightUnitOfMeasurement": "LBS",
            "specialInstructions": "TEST ONLY - SPECIAL INSTRUCTIONS - TEST ONLY",
            "dimensions": {
                "unitOfMeasurement": "IN",
                "length": 0,
                "width": 0,
                "height": 0
            }
        }
    ],
    "handlingUnits": [
        {
            "packageType": "Pallets",
            "quantity": 1,
            "length": null,
            "width": null,
            "height": null,
            "additionalWeight": null,
            "unitOfMeasurement": "",
            "weightUnitOfMeasurement": "",
            "products": [
                {
                    "packageType": "BOXS",
                    "quantity": 1,
                    "class": 200,
                    "weight": 210,
                    "weightUnitOfMeasurement": "LBS",
                    "dimensions": {
                        "unitOfMeasurement": "IN",
                        "length": 0,
                        "width": 0,
                        "height": 0
                    },
                    "nmfc": null,
                    "description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY",
                    "sku": null,
                    "referenceNumber": null,
                    "hazmatDetails": null,
                    "internationalDetails": null,
                    "isHazmat": false
                }
            ]
        }
    ],
    "loadAccessorials": [],
    "shipperAccessorials": [],
    "consigneeAccessorials": [],
    "referenceFields": [
        {
            "type": "OrderNumber",
            "value": "12345678",
            "printOnBol": true,
            "printOnShippingLabel": true
        }
    ],
    "insuranceInfo": null,
    "stops": [],
    "legs": [],
    "exported": false,
    "isMultiStop": false,
    "isMultiLeg": false,
    "dispatchResponse": null,
    "carbonQuote": {
        "offsetAmount": 100093,
        "offsetUnit": "g",
        "estimatedPrice": 40,
        "vendorFee": 8,
        "currency": "USD",
        "orderId": "ord_test_b3ac6e452dcbb730b6b20e760296c8f2"
    },
    "marketRates": [
        {
            "vendorName": "Greenscreens.ai",
            "highBuyRate": 567.4,
            "lowBuyRate": 350.35,
            "buyRate": 441.67,
            "startRate": 300,
            "confidenceLevel": 50,
            "currency": "USDollar",
            "date": "2024-03-24T14:15:22Z"
        }
    ]
}
🟠400Bad Request
🟠401Unauthorized
🟠422Client Error
🟠403Forbidden
🟠429Too Many Requests
Modified at 2025-05-23 18:26:35
Previous
Shipments
Next
Create an EZ Rate Shipment
Built with