UpdateLoad
POST/services/api/rest/UpdateLoadThis function will update an existing load in Banyan. If vital information is to be updated, this will trigger a rerate.
All fields must be provided. Not providing previously populated data will cause data to be lost.
If the following fields are changed, a rerate will be triggered:
ClientRefNum
InsuranceInfo
Shipper
- AddressInfo
- Dock ShipmentDateTime (Pickup time)
- if there is a Live Lane Special
- VendorID
- DCRefNum
Consignee
- AddressInfo
- VendorID
- DCRefNum
Products
- Adding or Removing Products
- Updating product information
- Dimensions
- Quantity
- Weight
- Package type
- Freight class
- isHazmat
Rate Services information
- Dimensions
- Quantity
- Package type
- Service type
- Weight
PackageInfo
- Declared Liability
- COD Amount
Accessorials
- Shipper
- Consignee
- Load
Request
Header Params
Content-Type
string
required
Example:
application/json
Accept
string
optional
Example:
application/json
Body Params application/json
No schema defined
Example
{
"AuthenticationData": {
"Username": "username",
"Password": "password",
"ClientRefNum": ""
},
"LoadInfo": {
"LoadID": 12345678,
"ManifestID": "culpa enim eu in reprehenderit",
"BOLNumber": "culpa sed in deserunt sint",
"CustomerPO": "sint ipsum Excepteur nulla",
"InvoiceID": "id aliquip ad quis nisi",
"BillingID": "proident",
"IncoTermID": "Delivered Duty Paid",
"UltimateDestinationCountryCode": "GF",
"PickupNumber": "https://loremflickr.com/640/480/fashion",
"EstimatedDeliveryDate": "2024-03-07T05:25:30.317Z",
"EstimatedPickupDate": "2024-03-07T03:37:00.971Z",
"ActualPickupDate": "2024-03-06T19:16:36.280Z",
"ActualDeliveryDate": "2024-03-07T04:00:47.747Z"
},
"BillTo": {
"Name": "fugit laborum neque",
"Note": "nostrud commodo Lorem reprehenderit cupidatat",
"ShipType": "ThirdParty",
"PayType": "Collect",
"AddressInfo": {
"Address1": "213 Jose Mission",
"Address2": "Apt. 683",
"City": "East Era",
"CountryName": "Turkey",
"CountryCode": "DJ",
"State": "FL",
"Zipcode": "27499",
"LocationName": "Hickle, Barrows and O'Keefe"
},
"ContactInfo": {
"FirstName": "Colt",
"LastName": "Johns",
"ContactName": "Olive Carroll",
"Phone": "1-759-927-1400 x366",
"PhoneExt": "ext. 123",
"Fax": "241-436-7857 x89784",
"Email": "Constantin_Hyatt@example.net"
},
"UseDefaultBillTo": true,
"UseDefaultShipType": false,
"UseDefaultPayType": false
},
"RateServices": [
{
"ServiceCode": "Parcel",
"ShippingQty": -57340525,
"PackageType": "Pails",
"EquipmentType": "Bulk_Truck",
"AdditionalWeight": -79578367.42973381,
"SpecialInstructions": "magna sint",
"Length": 2687851.8163169175,
"Width": 8820840.91510263,
"Height": -51173586.55921183,
"WeightUom": "LBS",
"SizeUom": "IN"
}
],
"Shipper": {
"ContactInfo": {
"FirstName": "Ward",
"LastName": "Schoen",
"ContactName": "Irvin Reichel",
"Phone": "(563) 890-8781 x16277",
"PhoneExt": "ext. 123",
"Fax": "(934) 717-9710 x78992",
"Email": "Idell.Stark46@example.net"
},
"AddressInfo": {
"Address1": "9801 Seamus Meadows",
"Address2": "Apt. 741",
"City": "South Armanistead",
"CountryName": "Greenland",
"CountryCode": "CY",
"State": "WY",
"Zipcode": "94136-0146",
"LocationName": "Parker - Ortiz"
},
"LocationName": "impedit similique hic",
"CompanyName": "molestiae expedita unde",
"Note": "culpa",
"CompanyID": "velit id officia",
"VendorID": "dolore enim magna cupidatat",
"DCRefNum": "ipsum Duis",
"Dock": {
"Name": "rerum reiciendis provident",
"Note": "aliqua proident",
"OpenTime": "2024-03-07T08:55:16.203Z",
"ShipmentDateTime": "2024-03-06T16:13:30.497Z",
"CloseTime": "2024-03-06T21:52:36.975Z",
"ConfirmationNumber": "ut esse",
"FCFS": true
}
},
"Consignee": {
"ContactInfo": {
"FirstName": "Darrick",
"LastName": "Kunze",
"ContactName": "Lamar Blanda",
"Phone": "(538) 735-7065",
"PhoneExt": "ext. 123",
"Fax": "(839) 440-9693",
"Email": "Karli.Lindgren@example.com"
},
"AddressInfo": {
"Address1": "9428 Aubree Cliffs",
"Address2": "Apt. 114",
"City": "South Dorian",
"CountryName": "Kenya",
"CountryCode": "DJ",
"State": "IN",
"Zipcode": "95530-0591",
"LocationName": "O'Connell, Gleichner and Hansen"
},
"LocationName": "hic dignissimos minima",
"CompanyName": "cupiditate quibusdam soluta",
"Note": "incididunt",
"CompanyID": "eiusmod",
"VendorID": "Excepteur cillum",
"DCRefNum": "id culpa nulla quis",
"Dock": {
"Name": "unde placeat iusto",
"Note": "esse",
"OpenTime": "2024-03-07T01:03:35.807Z",
"ShipmentDateTime": "2024-03-06T14:39:02.370Z",
"CloseTime": "2024-03-07T03:36:34.962Z",
"ConfirmationNumber": "Lorem aute commodo deserunt eu",
"FCFS": false
}
},
"PackageInfo": {
"CODAmount": null,
"DeclaredLiability": null,
"RouteNumber": "consectetur Lorem"
},
"Products": [
{
"Quantity": 76655423,
"PackageType": "Tubes",
"Weight": 57043099.087427825,
"Class": "c200",
"NMFC": "proident reprehenderit adipisicing enim",
"SKU": null,
"IsHazmat": true,
"UnNumber": null,
"HazMatShippingName": "sequi non nostrum",
"HazMatClass": "quis incididunt cupidatat Lorem",
"HazMatPkgGroup": "adipisicing",
"HazmatPhoneNumber": "500.865.9788 x496",
"HazmatPhoneExt": "417-521-2679",
"HazMatContact": "aute",
"HazMatPoison": true,
"Description": "Maiores fuga perferendis libero maxime earum. Nemo deserunt velit dolor nulla sequi blanditiis nobis. Sint aperiam debitis perferendis ullam molestias ab. Rem quae fugiat dolorem natus quia odio nesciunt laudantium.",
"Length": 13919414.380413994,
"Width": -72454227.20694625,
"Height": -27261425.597840548,
"UOM": "English",
"SortOrder": -93651533,
"ReferenceNumber": null,
"ParcelOptions": {
"DeliveryConfirmation": "CertifiedMail",
"COD": "None",
"CODAmount": -29165237.34897116,
"AdditionalHandling": false,
"LargePackage": true,
"DeclaredValue": -74323325.37354761,
"UnitValue": -51529869.283867314,
"UnitWeight": 92536376.04096636,
"UnitType": null
},
"InternationalOptions": {
"ScheduleBCode": "aliqua Duis",
"HarmonizedSystemCode": null,
"ECCN": null,
"UnitOriginCountryCode": "FI"
}
}
],
"ShipperAccessorials": {
"AppointmentRequired": false,
"InsidePickup": true,
"SortSegregate": false,
"PalletJack": true,
"ResidentialPickup": false,
"LiftgatePickup": false,
"MarkingTagging": true,
"TradeShowPickup": true,
"NYCMetro": false,
"NonBusinessHourPickup": true,
"LimitedAccessType": "Unspecified"
},
"ConsigneeAccessorials": {
"AppointmentRequired": false,
"InsideDelivery": false,
"SortSegregate": true,
"PalletJack": false,
"ResidentialDelivery": false,
"LiftgateDelivery": true,
"MarkingTagging": true,
"TradeShowDelivery": true,
"NYCMetro": false,
"DeliveryNotification": false,
"TwoHourSpecialDelivery": false,
"NonBusinessHourDelivery": true,
"LimitedAccessType": "School"
},
"LoadAccessorials": {
"Guaranteed": true,
"TimeDefinite": false,
"Expedited": true,
"HolidayPickup": true,
"HolidayDelivery": false,
"WeightDetermination": false,
"BlindShipment": true,
"BlanketService": true,
"SingleShipment": false,
"CustomsInBond": false,
"OverDimension": false,
"Stackable": false,
"Turnkey": true,
"FoodGradeProducts": false,
"TSA": false,
"Bulkhead": false,
"SignatureRequired": true,
"BlanketServiceChilled": true,
"BlanketServiceFrozen": false,
"SaturdayDelivery": true,
"SecondMan": true,
"ReturnReceipt": true,
"ShipmentHold": false,
"ProactiveResponse": false,
"ShipperRelease": true,
"WhiteGlove": true,
"RestrictedDelivery": true,
"TankerEndorsedDriverRequired": true
},
"Return Location": {
"CompanyName": "iure suscipit expedita",
"ContactInfo": {
"FirstName": "Macy",
"LastName": "Satterfield",
"ContactName": "Maxine Torphy Sr.",
"Phone": "938.633.6092 x819",
"PhoneExt": "ext. 123",
"Fax": "876-912-8712 x2903",
"Email": "Ettie93@example.net"
},
"AddressInfo": {
"Address1": "0796 Bogisich Islands",
"Address2": "Suite 266",
"City": "Dickistead",
"CountryName": "Angola",
"CountryCode": "ML",
"State": "MD",
"Zipcode": "91296-0596",
"LocationName": "Powlowski LLC"
}
},
"UserDefined": [
{
"Name": "aspernatur id dolore",
"Value": "id"
}
],
"ReferenceField": [
{
"Type": "sint qui Lorem",
"Value": "reprehenderit elit commodo",
"PrintOnBOL": true,
"PrintOnShippingLabel": false
}
],
"InsuranceInfo": {
"InsuranceWanted": true,
"VendorCode": "culpa ipsum amet mollit",
"CommodityTypeCode": "anim consequat sed",
"CommodityConditionCode": "ad sit",
"InsuredValue": 24866636.033198833
}
}Request samples
Responses
UpdateLoad - 200 OK - Re-Rate(200)
UpdateLoad - 200 OK - Re-Rate
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
ExampleUpdateLoad - 200 OK - Re-Rate
{
"Success": true,
"NeedsReRated": false,
"ReRateReason": "Vital information has been updated: The shipper's city changed from NORTH RIDGEVILLE to SOUTH BEND. The shipper's state changed from OH to IN. The shipper's zip code changed from 44039 to 46628. The consignee's city changed from CHICAGO to FOLEY. The consignee's state changed from IL to AL. The consignee's zip code changed from 60606 to 36535. Product 1's weight changed from 2500 to 1200. Service 1 package type changed from PAIL to . ",
"RatingComplete": true,
"Load": {
"AuthenticationData": {
"Username": "_",
"Password": "_",
"ClientRefNum": "_"
},
"Loadinfo": {
"LoadID": 13624203,
"ManifestID": null,
"BOLNumber": "180724",
"CustomerPO": "",
"InvoiceID": "",
"BillingID": "",
"IncoTermID": null
},
"BillTo": {
"Name": "",
"Note": "",
"ShipType": 1,
"PayType": 1,
"UseDefaultBillTo": false,
"AddressInfo": {
"Address1": "123245 Test St.",
"Address2": "",
"City": "North Ridgeville",
"CountryName": null,
"CountryCode": "",
"State": "OH",
"Zipcode": "44039",
"LocationName": "Test"
},
"ContactInfo": {
"FirstName": "",
"LastName": "",
"ContactName": "",
"Phone": "",
"PhoneExt": "",
"Fax": "",
"Email": ""
}
},
"InsuranceInfo": null,
"RateServices": [
{
"ServiceCode": 1,
"ShippingQty": 3,
"PackageType": 29,
"EquipmentType": 5,
"AdditionalWeight": 50,
"SpecialInstructions": "Do not break",
"Length": null,
"Width": null,
"Height": null,
"WeightUom": 1,
"SizeUom": 1
}
],
"Shipper": {
"ContactInfo": {
"FirstName": "User",
"LastName": "User",
"ContactName": "User",
"Phone": "3211231234",
"PhoneExt": "",
"Fax": "",
"Email": "test@test.com"
},
"AddressInfo": {
"Address1": "123245 Test St.",
"Address2": "",
"City": "South Bend",
"CountryName": null,
"CountryCode": "",
"State": "IN",
"Zipcode": "46628",
"LocationName": "Test"
},
"CompanyName": "",
"Note": "",
"CompanyID": "",
"LocationName": null,
"VendorID": null,
"DCRefNum": null,
"Dock": {
"Name": "Main Dock",
"Note": "",
"OpenTime": "2018-04-27T08:00:00",
"ShipmentDateTime": "2018-04-27T12:00:00",
"CloseTime": "2018-04-27T17:00:00",
"ConfirmationNumber": "",
"FCFS": true
}
},
"Consignee": {
"ContactInfo": {
"FirstName": "",
"LastName": "",
"ContactName": "",
"Phone": "",
"PhoneExt": "",
"Fax": "",
"Email": ""
},
"AddressInfo": {
"Address1": "54321 Test Blvd.",
"Address2": "",
"City": "Foley",
"CountryName": null,
"CountryCode": "",
"State": "AL",
"Zipcode": "36535",
"LocationName": "Test"
},
"CompanyName": "",
"Note": "",
"CompanyID": "",
"LocationName": null,
"VendorID": null,
"DCRefNum": null,
"Dock": {
"Name": "Main Dock",
"Note": "",
"OpenTime": "2018-07-11T08:00:00",
"ShipmentDateTime": "2018-07-11T12:00:00",
"CloseTime": "2018-07-11T17:00:00",
"ConfirmationNumber": "",
"FCFS": true
}
},
"PackageInfo": {
"CODAmount": 0,
"DeclaredLiability": 0
},
"Products": [
{
"Quantity": 3,
"PackageType": 29,
"Weight": 1200,
"Class": 9,
"NMFC": "",
"SKU": "",
"IsHazmat": false,
"HazmatPhoneNumber": "",
"HazmatPhoneExt": "",
"Description": "Testing",
"Length": 48,
"Width": 48,
"Height": 24,
"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": "UpdateLoad ImportID: 21773374",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:17:06"
},
{
"Text": "Load has been updated using the update load web method.",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:17:06"
},
{
"Text": "Load was moved into cancelled status with the web service function CancelLoad.",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:06:39"
},
{
"Text": "Status changed from Quoted to Cancelled.",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:06:39"
},
{
"Text": "Load Was UnBooked. Original Pro Number assigned - - has been deleted.",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:04:00"
},
{
"Text": "LoadID:13624203BolNum:180724QuoteID:131097567ManifestID:ActualCharge:489.24PickupDate:8/12/2018AccessTime:12:00CarrierID:7671Web_Dispatch:FalseEDI_Dispatch:False",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:01:42"
},
{
"Text": "The user declined to send a pick-up request for this shipment by unchecking the Submit Pickup Request box.",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:01:42"
},
{
"Text": "<a href=javascript:ShowTerminalLink('7671','13624203')>Terminal Link</a>",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:01:42"
},
{
"Text": "Load booked with R L Carriers.",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:01:42"
},
{
"Text": "Awarded quote email was not sent due to permissions.",
"User": "Mike Jones",
"DateStamp": "2018-08-12T16:01:42"
},
{
"Text": "Original shipperDateTime = 08/12/2018Original consigneedatetime = 04/27/2018New shipperDateTime = 08/12/2018New consigneedatetime = 08/15/2018ActualPickupDate = 08/12/2018ActualDeliverDate = 08/15/2018",
"User": "Automation",
"DateStamp": "2018-08-12T16:01:42"
},
{
"Text": "Override for 781629580 - <br />- Default Ship<br />- Billing",
"User": "Automation",
"DateStamp": "2018-07-17T07:39:38"
},
{
"Text": "Trucking Company 1: Pickup Date cannot be less than Current Date. Please double check Pickup Date.",
"User": "Automation",
"DateStamp": "2018-07-17T07:39:36"
}
],
"Error": null
}Last modified: 2 months ago