ImportForQuote

POST

/services/api/rest/ImportForQuote

This function will import a shipment in the Banyan system and will initiate the rating process and will return a response immediately. Following this request would be a loop of calling GetQuotes to return the quotes on the created shipment.

Note:

When using accessorials, rate request will only be sent to carriers that accept the select accessorials. COD and Declared liability are considered accessorials.

User defined values and reference fields are not required for a request, but are available for custom fields to be passed and related to the shipment

Request

Header Params

Body Params application/json

Example

{
    "AuthenticationData": {
        "Username": "{{username}}",
        "Password": "{{password}}",
        "ClientRefNum": ""
    },
    "Loadinfo": {
        "CustomerPO": "Cust PO Number"
    },
    "BillTo": {
        "Name": "Banyan Technology",
        "ShipType": "Shipper",
        "PayType": "Prepaid",
        "UseDefaultBillTo": false,
        "AddressInfo": {
            "Address1": "30505 Clemens Rd",
            "City": "Westlake",
            "CountryName": null,
            "CountryCode": "USA",
            "State": "OH",
            "Zipcode": "44145",
            "LocationName": "Banyan Technology"
        },
        "ContactInfo": {
            "FirstName": "Randy",
            "LastName": "Marsh",
            "Phone": "800-835-1274",
            "Email": "noreply@banyantechnology.com"
        }
    },
    "RateServices": [
        {
            "ServiceCode": "LTL",
            "ShippingQty": "1",
            "PackageType": "Pallets",
            "EquipmentType": "VanTrailer_Standard",
            "AdditionalWeight": "50",
            "SpecialInstructions": "Do not break",
            "Length": "40",
            "Width": "48",
            "Height": "40",
            "WeightUom": "LBS",
            "SizeUom": "IN"
        }
    ],
    "Shipper": {
        "ContactInfo": {
            "FirstName": "Jon",
            "LastName": "Snow",
            "Phone": "867-5309",
            "Email": ""
        },
        "AddressInfo": {
            "Address1": "123245 Test St.",
            "City": "North Ridgeville",
            "CountryCode": "USA",
            "State": "OH",
            "Zipcode": "44039",
            "LocationName": "Test"
        },
        "CompanyName": "Test",
        "LocationName": "Test",
        "Dock": {
            "Name": "Main Dock",
            "OpenTime": "2024-04-27T08:00:00",
            "ShipmentDateTime": "2024-04-27T12:00:00",
            "CloseTime": "2024-04-27T17:00:00"
        }
    },
    "Consignee": {
        "ContactInfo": {
            "FirstName": "Al",
            "LastName": "Bundy",
            "Phone": "",
            "Email": ""
        },
        "AddressInfo": {
            "Address1": "9764 Jeopardy Lane",
            "City": "Chicago",
            "CountryName": null,
            "CountryCode": "USA",
            "State": "IL",
            "Zipcode": "60015",
            "LocationName": "The Bundy house"
        },
        "CompanyName": "Test1 comp name",
        "LocationName": "Test1 loc name",
        "Dock": {
            "Name": "Main Dock",
            "OpenTime": "2024-04-29T08:00:00",
            "ShipmentDateTime": "2024-04-29T12:00:00",
            "CloseTime": "2024-04-29T17:00:00"
        }
    },
    "Products": [
        {
            "Quantity": 12,
            "PackageType": "Boxes",
            "Weight": 600,
            "Class": "c100",
            "NMFC": "2070",
            "SKU": "Sku-12345",
            "IsHazmat": false,
            "Description": "Women's shoes",
            "Length": 12,
            "Width": 10,
            "Height": 12,
            "SortOrder": 1
        }
    ],
    "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
    }
}

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/ImportForQuote' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AuthenticationData": {
        "Username": "{{username}}",
        "Password": "{{password}}",
        "ClientRefNum": ""
    },
    "Loadinfo": {
        "CustomerPO": "Cust PO Number"
    },
    "BillTo": {
        "Name": "Banyan Technology",
        "ShipType": "Shipper",
        "PayType": "Prepaid",
        "UseDefaultBillTo": false,
        "AddressInfo": {
            "Address1": "30505 Clemens Rd",
            "City": "Westlake",
            "CountryName": null,
            "CountryCode": "USA",
            "State": "OH",
            "Zipcode": "44145",
            "LocationName": "Banyan Technology"
        },
        "ContactInfo": {
            "FirstName": "Randy",
            "LastName": "Marsh",
            "Phone": "800-835-1274",
            "Email": "noreply@banyantechnology.com"
        }
    },
    "RateServices": [
        {
            "ServiceCode": "LTL",
            "ShippingQty": "1",
            "PackageType": "Pallets",
            "EquipmentType": "VanTrailer_Standard",
            "AdditionalWeight": "50",
            "SpecialInstructions": "Do not break",
            "Length": "40",
            "Width": "48",
            "Height": "40",
            "WeightUom": "LBS",
            "SizeUom": "IN"
        }
    ],
    "Shipper": {
        "ContactInfo": {
            "FirstName": "Jon",
            "LastName": "Snow",
            "Phone": "867-5309",
            "Email": ""
        },
        "AddressInfo": {
            "Address1": "123245 Test St.",
            "City": "North Ridgeville",
            "CountryCode": "USA",
            "State": "OH",
            "Zipcode": "44039",
            "LocationName": "Test"
        },
        "CompanyName": "Test",
        "LocationName": "Test",
        "Dock": {
            "Name": "Main Dock",
            "OpenTime": "2024-04-27T08:00:00",
            "ShipmentDateTime": "2024-04-27T12:00:00",
            "CloseTime": "2024-04-27T17:00:00"
        }
    },
    "Consignee": {
        "ContactInfo": {
            "FirstName": "Al",
            "LastName": "Bundy",
            "Phone": "",
            "Email": ""
        },
        "AddressInfo": {
            "Address1": "9764 Jeopardy Lane",
            "City": "Chicago",
            "CountryName": null,
            "CountryCode": "USA",
            "State": "IL",
            "Zipcode": "60015",
            "LocationName": "The Bundy house"
        },
        "CompanyName": "Test1 comp name",
        "LocationName": "Test1 loc name",
        "Dock": {
            "Name": "Main Dock",
            "OpenTime": "2024-04-29T08:00:00",
            "ShipmentDateTime": "2024-04-29T12:00:00",
            "CloseTime": "2024-04-29T17:00:00"
        }
    },
    "Products": [
        {
            "Quantity": 12,
            "PackageType": "Boxes",
            "Weight": 600,
            "Class": "c100",
            "NMFC": "2070",
            "SKU": "Sku-12345",
            "IsHazmat": false,
            "Description": "Women'\''s shoes",
            "Length": 12,
            "Width": 10,
            "Height": 12,
            "SortOrder": 1
        }
    ],
    "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
    }
}'

Responses

🟢200ImportForQuote - 200 OK

application/json

Body

Example

{
    "Load": {
        "AuthenticationData": {
            "Username": "_",
            "Password": "_",
            "ClientRefNum": "_"
        },
        "DebugMode": false,
        "Loadinfo": {
            "LoadID": 62339128,
            "ManifestID": "",
            "BOLNumber": "BWS2406700008",
            "CustomerPO": "Cust PO Number",
            "InvoiceID": "",
            "BillingID": "",
            "IncoTermID": null,
            "UltimateDestinationCountryCode": "",
            "PickupNumber": null,
            "EstimatedDeliveryDate": "0001-01-01T00:00:00",
            "EstimatedPickupDate": "0001-01-01T00:00:00",
            "ActualPickupDate": "0001-01-01T00:00:00",
            "ActualDeliveryDate": "0001-01-01T00:00:00"
        },
        "BillTo": {
            "Name": "Banyan Technology",
            "Note": "",
            "ShipType": 0,
            "PayType": 1,
            "UseDefaultBillTo": false,
            "AddressInfo": {
                "Address1": "30505 Clemens Rd",
                "Address2": "",
                "City": "Westlake",
                "CountryName": "United States",
                "CountryCode": "USA",
                "State": "OH",
                "Zipcode": "44145",
                "LocationName": "Banyan Technology"
            },
            "ContactInfo": {
                "FirstName": "",
                "LastName": "Marsh",
                "ContactName": "Marsh",
                "Phone": "800-835-1274",
                "PhoneExt": "",
                "Fax": "",
                "Email": "noreply@banyantechnology.com"
            },
            "UseDefaultShipType": false,
            "UseDefaultPayType": false
        },
        "InsuranceInfo": null,
        "RateServices": [
            {
                "ServiceCode": 1,
                "ShippingQty": 1,
                "PackageType": 29,
                "EquipmentType": 5,
                "AdditionalWeight": 50,
                "SpecialInstructions": "Do not break",
                "Length": 40,
                "Width": 48,
                "Height": 40,
                "WeightUom": 1,
                "SizeUom": 1
            }
        ],
        "Shipper": {
            "ContactInfo": {
                "FirstName": "Jon",
                "LastName": "Snow",
                "ContactName": "Jon Snow",
                "Phone": "867-5309",
                "PhoneExt": "",
                "Fax": "",
                "Email": ""
            },
            "AddressInfo": {
                "Address1": "123245 Test St.",
                "Address2": "",
                "City": "North Ridgeville",
                "CountryName": "United States",
                "CountryCode": "USA",
                "State": "OH",
                "Zipcode": "44039",
                "LocationName": "Test"
            },
            "CompanyName": "Test",
            "Note": "",
            "CompanyID": "",
            "LocationName": null,
            "VendorID": "",
            "DCRefNum": "",
            "Dock": {
                "Name": "Main Dock",
                "Note": "",
                "OpenTime": "2024-04-27T08:00:00",
                "ShipmentDateTime": "2024-04-27T12:00:00",
                "CloseTime": "2024-04-27T17:00:00",
                "ConfirmationNumber": "",
                "FCFS": false
            }
        },
        "Consignee": {
            "ContactInfo": {
                "FirstName": "Al",
                "LastName": "Bundy",
                "ContactName": "Al Bundy",
                "Phone": "",
                "PhoneExt": "",
                "Fax": "",
                "Email": ""
            },
            "AddressInfo": {
                "Address1": "9764 Jeopardy Lane",
                "Address2": "",
                "City": "Chicago",
                "CountryName": "United States",
                "CountryCode": "USA",
                "State": "IL",
                "Zipcode": "60015",
                "LocationName": "The Bundy house"
            },
            "CompanyName": "Test1 comp name",
            "Note": "",
            "CompanyID": "",
            "LocationName": null,
            "VendorID": "",
            "DCRefNum": "",
            "Dock": {
                "Name": "Main Dock",
                "Note": "",
                "OpenTime": "2024-04-29T08:00:00",
                "ShipmentDateTime": "2024-04-29T12:00:00",
                "CloseTime": "2024-04-29T17:00:00",
                "ConfirmationNumber": "",
                "FCFS": false
            }
        },
        "ReturnLocation": null,
        "PackageInfo": {
            "CODAmount": 0,
            "DeclaredLiability": 0,
            "RouteNumber": ""
        },
        "Products": [
            {
                "Quantity": 12,
                "PackageType": 7,
                "Weight": 600,
                "Class": 9,
                "NMFC": "2070",
                "SKU": "Sku-12345",
                "IsHazmat": false,
                "HazmatPhoneNumber": "",
                "HazmatPhoneExt": "",
                "Description": "Women's shoes",
                "Length": 12,
                "Width": 10,
                "Height": 12,
                "UOM": 0,
                "SortOrder": 1,
                "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": 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,
            "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,
            "TankerEndorsedDriverRequired": false
        },
        "UserDefined": [],
        "ReferenceField": []
    },
    "Quotes": null,
    "PendingQuotes": null,
    "FailedQuotes": null,
    "Notes": [
        {
            "Text": "Load Created",
            "User": "Test User",
            "DateStamp": "2024-03-07T15:40:27",
            "NoteType": 10
        },
        {
            "Text": "Original BOLID: BOL12345",
            "User": "Automation",
            "DateStamp": "2024-03-07T15:40:27",
            "NoteType": 7
        }
    ],
    "RatingComplete": false,
    "ErrorMessage": null
}

🟢200Invalid Credentials

Modified at 2024-09-16 11:42:17

Version 2

ImportForQuote_Sync