EzRate - Banyan Technology LIVE Connect™

This endpoint is permission based. For access please contact your Banyan representative.

This function will create an EZ Rate shipment in Banyan. EZ Rate shipments are used as a quick quote function. This function will take minimal shipment information and start our rating engine.

This is an asynchronous function, so this should be followed by a GetQuotes request until rating on the shipment has completed which is a bit flag within the GetQuotes response.

Request

Header Params

Body Params application/json

Example

{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "Loadinfo":{

   },
   "RateServices":[
      {
         "ServiceCode":1,
         "ShippingQty":1,
         "PackageType":29,
         "EquipmentType":5
      }
   ],
   "ShipperCity":"Cleveland",
   "ShipperState":"OH",
   "ShipperZipcode":"44133",
   "ShipperCountryCode":"USA",
   "ShipperCountryName":"United States",
   "ConsigneeCity":"Chicago",
   "ConsigneeState":"IL",
   "ConsigneeZipcode":"60606",
   "ConsigneeCountryCode":"USA",
   "ConsigneeCountryName":"United States",
   "ShipType":0,
   "PayType":1,
   "PackageInfo":{

   },
   "Products":[
      {
         "Quantity":1,
         "PackageType":29,
         "Weight":400,
         "Class":2,
         "IsHazmat":false,
         "UOM":0,
         "SortOrder":1
      }
   ],
   "ShipperAccessorials":{
      "AppointmentRequired":false,
      "InsidePickup":false,
      "SortSegregate":false,
      "PalletJack":false,
      "ResidentialPickup":false,
      "LiftgatePickup":false,
      "MarkingTagging":false,
      "TradeShowPickup":false,
      "NYCMetro":false,
      "NonBusinessHoursPickup":false
   },
   "ConsigneeAccessorials":{
      "AppointmentRequired":false,
      "InsideDelivery":false,
      "SortSegregate":false,
      "PalletJack":false,
      "ResidentialDelivery":false,
      "LiftgateDelivery":false,
      "MarkingTagging":false,
      "TradeShowDelivery":false,
      "NYCMetro":false,
      "DeliveryNotification":false,
      "NonBusinessHoursDelivery":false
   },
   "LoadAccessorials":{
      "Guaranteed":false,
      "TimeDefinite":false,
      "Expedited":false,
      "HolidayPickup":false,
      "HolidayDelivery":false,
      "WeightDetermination":false,
      "BlindShipment":false,
      "BlanketService":false,
      "SingleShipment":false,
      "CustomsInBond":false,
      "OverDimension":false,
      "Stackable":false,
      "Turnkey":false,
      "FoodGradeProducts":false,
      "SaturdayDelivery":false,
      "RestrictedDelivery":false,
      "ShipperRelease":false,
      "ReturnReceipt":false,
      "SecondMan":false,
      "WhiteGlove":false,
      "ProactiveResponse":false,
      "ShipmentHold":false,
      "TankerEndorsedDriverRequired":false
   }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/EzRate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "Loadinfo":{

   },
   "RateServices":[
      {
         "ServiceCode":1,
         "ShippingQty":1,
         "PackageType":29,
         "EquipmentType":5
      }
   ],
   "ShipperCity":"Cleveland",
   "ShipperState":"OH",
   "ShipperZipcode":"44133",
   "ShipperCountryCode":"USA",
   "ShipperCountryName":"United States",
   "ConsigneeCity":"Chicago",
   "ConsigneeState":"IL",
   "ConsigneeZipcode":"60606",
   "ConsigneeCountryCode":"USA",
   "ConsigneeCountryName":"United States",
   "ShipType":0,
   "PayType":1,
   "PackageInfo":{

   },
   "Products":[
      {
         "Quantity":1,
         "PackageType":29,
         "Weight":400,
         "Class":2,
         "IsHazmat":false,
         "UOM":0,
         "SortOrder":1
      }
   ],
   "ShipperAccessorials":{
      "AppointmentRequired":false,
      "InsidePickup":false,
      "SortSegregate":false,
      "PalletJack":false,
      "ResidentialPickup":false,
      "LiftgatePickup":false,
      "MarkingTagging":false,
      "TradeShowPickup":false,
      "NYCMetro":false,
      "NonBusinessHoursPickup":false
   },
   "ConsigneeAccessorials":{
      "AppointmentRequired":false,
      "InsideDelivery":false,
      "SortSegregate":false,
      "PalletJack":false,
      "ResidentialDelivery":false,
      "LiftgateDelivery":false,
      "MarkingTagging":false,
      "TradeShowDelivery":false,
      "NYCMetro":false,
      "DeliveryNotification":false,
      "NonBusinessHoursDelivery":false
   },
   "LoadAccessorials":{
      "Guaranteed":false,
      "TimeDefinite":false,
      "Expedited":false,
      "HolidayPickup":false,
      "HolidayDelivery":false,
      "WeightDetermination":false,
      "BlindShipment":false,
      "BlanketService":false,
      "SingleShipment":false,
      "CustomsInBond":false,
      "OverDimension":false,
      "Stackable":false,
      "Turnkey":false,
      "FoodGradeProducts":false,
      "SaturdayDelivery":false,
      "RestrictedDelivery":false,
      "ShipperRelease":false,
      "ReturnReceipt":false,
      "SecondMan":false,
      "WhiteGlove":false,
      "ProactiveResponse":false,
      "ShipmentHold":false,
      "TankerEndorsedDriverRequired":false
   }
}'

Responses

🟢200EzRate - 200 OK

application/json

Body

Example

{
    "Load": {
        "AuthenticationData": {
            "Username": "_",
            "Password": "_",
            "ClientRefNum": "_"
        },
        "Loadinfo": {
            "LoadID": 13642380,
            "ManifestID": null,
            "BOLNumber": "180802",
            "CustomerPO": "",
            "InvoiceID": "",
            "BillingID": "",
            "IncoTermID": null
        },
        "RateServices": [
            {
                "ServiceCode": 1,
                "ShippingQty": 1,
                "PackageType": 29,
                "EquipmentType": 5,
                "AdditionalWeight": 0,
                "SpecialInstructions": "",
                "Length": null,
                "Width": null,
                "Height": null,
                "WeightUom": 1,
                "SizeUom": 1
            }
        ],
        "ShipperCity": "Cleveland",
        "ShipperState": "OH",
        "ShipperZipcode": "44133",
        "ShipperCountryCode": "USA",
        "ShipperCountryName": "United States",
        "ConsigneeCity": "Cleveland",
        "ConsigneeState": "OH",
        "ConsigneeZipcode": "44133",
        "ConsigneeCountryCode": "USA",
        "ConsigneeCountryName": "United States",
        "ShipType": 0,
        "PayType": 1,
        "PackageInfo": {
            "CODAmount": 0,
            "DeclaredLiability": 0
        },
        "Products": [
            {
                "Quantity": 1,
                "PackageType": 29,
                "Weight": 400,
                "Class": 2,
                "NMFC": "",
                "SKU": "",
                "IsHazmat": false,
                "HazmatPhoneNumber": "",
                "HazmatPhoneExt": "",
                "Description": "",
                "Length": 0,
                "Width": 0,
                "Height": 0,
                "UOM": 0,
                "SortOrder": 1,
                "ReferenceNumber": "",
                "ParcelOptions": {
                    "DeliveryConfirmation": 0,
                    "COD": 0,
                    "CODAmount": 0,
                    "AdditionalHandling": false,
                    "LargePackage": false,
                    "DeclaredValue": 0
                }
            }
        ],
        "ShipperAccessorials": {
            "AppointmentRequired": false,
            "InsidePickup": false,
            "SortSegregate": false,
            "PalletJack": false,
            "ResidentialPickup": false,
            "LiftgatePickup": false,
            "MarkingTagging": false,
            "TradeShowPickup": false,
            "NYCMetro": false,
            "NonBusinessHourPickup": false,
            "LimitedAccessType": null
        },
        "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,
            "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": []
    },
    "Quotes": null,
    "Notes": [
        {
            "Text": "Load Created",
            "User": "Joe Zagorski",
            "DateStamp": "2018-08-12T14:38:58"
        },
        {
            "Text": "Original BOLID: 180802",
            "User": "Automation",
            "DateStamp": "2018-08-12T14:38:58"
        }
    ],
    "RatingComplete": false,
    "ErrorMessage": null
}