WIXLIB

Request FieldsThe table below describes the LTL Rate Quote input structure and all the possible fields.PathType/Required/Size DescriptionaccountNumberStringRequired7 Max/MincustomerTypeStringRequiredsee valid valuesoriginCityStringConditional30 MaxoriginStateStringConditionalA 7 digit Averitt account number. This account is eitherthe Shipper, Consignee or Third Party per the value setin the Customer Type field. Note that youraverittexpress.com username, that is associated withyour api key, must have access to this account number.If the account is the origin location then the value of thisfield must be 'Shipper'. If the account is the destinationlocation then the value of this field must be 'Consignee'.If the account is neither the origin location nor thedestination location then the value of the field must be'Third Party'. Note that your averittexpress.comusername, that is associated with your api key, has to besetup to use 'Third Party' in order to use it as it is not adefault privilege. Valid values are: 'Shipper', 'Consignee',and 'Third Party'.The origin city of the shipment. If the Customer Type is'Shipper' then this field is optional as the City will beretrieved from the Averitt database for the givenAccount Number. If the Customer Type is 'Shipper' andthe City is provided then it must match the city onrecord for the given Account Number. If the CustomerType is 'Consignee' or 'Third Party' then this field isrequired along with State and Zip fields and theCity/State/Zip combination must be valid.The origin state of the shipment. ( 2 character stateabbreviation in capital letters) See above for city as thelogic is the same.2 Max/MinoriginZipStringConditionalThe origin zip of the shipment. See above for city as thelogic is the same.6 MaxdestinationCityStringConditional30 MaxThe destination city of the shipment. If the CustomerType is 'Consignee' then this field is optional as the Citywill be retrieved from the Averitt database for the givenAccount Number. If the Customer Type is 'Consignee'and the City is provided then it must match the city onrecord for the given Account Number. If the CustomerType is 'Shipper' or 'Third Party' then this field isrequired along with State and Zip fields and theCity/State/Zip combination must be valid.11

PathType/Required/Size DescriptiondestinationStateStringConditionalThe destination state of the shipment. (2 character stateabbreviation in capital letters) See above for city as thelogic is the same.2 Max/MindestinationZipStringConditionalThe destination zip of the shipment. See above for city asthe logic is the same.6 MaxshipDateStringOptionalThe date the shipment will be pickedup. (ISO 8601format: yyyy-MM-dd)If the Ship Date is omitted or isblank then the current date will be used.see required dateformatpaymentTypeStringRequiredEnter 'Prepaid' if Shipper will be invoiced for freightcharges. Enter 'Collect' if Consignee will be invoiced forfreight charges. Valid values are: 'Prepaid' and 'Collect'.see valid valuesshipmentInfoObjectRequiredN/A - objectidentifiershipmentInfo.items Array[]RequiredN/A - arrayidentifiershipmentInfo.items String[].shipmentClassRequiredsee valid valuesshipmentInfo.items String[].shipmentWeightRequiredMarks the start of a nested JSON object called ShipmentInfo that holds information about the items beingshipped and the requested accessorials and othershipment specific related information. This objectidentifier is required.Marks the start of an Array of Shipment Details. Pleaseenter the information for each commodity in yourshipment, leaving fields blank that do not apply. Thisarray identifier is required. At least one array element isrequired.Enter the freight class for this line item. Freight class is astandardized classification system for commoditiestransported via less-than-truckload (LTL) freightshipping. Valid values are: '50', '55', '60', '65', '70', '77.5','85', '92.5', '100', '110', '125', '150', '175', '200', '250', '300','400', '500'.Enter the weight (lbs) for this line item. Valid values arepositive whole numbers.7 MaxEnter the National Motor Freight Classification Numberfor this item. This field is usually not required for mostcustomers and if it is required then an error messagemust be valid NMFC# will be returned indicating that it is required.shipmentInfo.items String[].nmfcNumberConditionalshipmentInfo.items String[].nmfcSubNumberConditionalmust be valid NMFCSub#12Enter the National Motor Freight Classification SubNumber, if any, for this item. This field is usually notrequired for most customers and if it is required then anerror message will be returned indicating that it isrequired.

PathType/Required/Size DescriptionshipmentInfo.acces ObjectsorialsOptionalN/A - objectidentifiershipmentInfo.acces nkshipmentInfo.acces e/false/blankshipmentInfo.acces e/false/blankshipmentInfo.acces ankshipmentInfo.acces pmentInfo.acces Booleansorials.hazmatOptionaltrue/false/blankMarks the start of a nested JSON object calledAccessorials that holds information about theaccessorials included in this rate quote. Accessorials areadditional services required for your delivery.Accessorials are subject to additional charges based onyour account’s pricing. If omitted then no accessorialsare included with this rate quote (same as if all whereset to 'false'. Also if any one accessorial is omited thenit’s default value is 'false'.Set to 'true' if you are requesting that a notice, verbal orwritten, be furnished to the consignee upon the arrivalof the shipment. The 'Guaranteed By 5' Delivery Optionis not available with Arrival Notify.Set to 'true' if the delivery is to be made to a conventioncenter, amusement park, trade show, craft show,traveling show, chautauquas, fairs, carnivals,exhibitions, expositions, furniture shows or suchvenues. The 'Guaranteed By 5' Delivery Option is notavailable with Convention Center Delivery.Set to 'true' if the delivery is to be made to a constructionsite. Construction sites include areas where building,excavating, erecting, construction and road building iscarried on. The 'Guaranteed By 5' Delivery Option is notavailable with Construction Site Delivery. ResidentialDelivery and Construction Site Delivery cannot beselected together. Non-Commercial Pickup/Delivery andConstruction Site Delivery cannot be selected together.Set to 'true' if the delivery is to be made away from theimmediate adjacent unloading locations. The'Guaranteed By 5' Delivery Option is not available withInside Delivery.Set to 'true' if the shipment requires a hydraulic liftingor lowering device to accomplish delivery when thedestination service center does not have equipment.Charges will be equal to amount AVRT pays forpurchasing service from a third party.The 'GuaranteedBy 5' Delivery Option is not available with Liftgate.Set to 'true' if the shipment contains any material thatwould be deemed as hazardous material by the federalgovernment. The 'Guaranteed By 5' Delivery Option isnot available with Hazmat.13

PathType/Required/Size DescriptionshipmentInfo.acces se/blankshipmentInfo.acces Booleansorials.nonCommercialPickupDelivery Optionaltrue/false/blankshipmentInfo.acces e/blankshipmentInfo.numPi StringecesConditionalSet to 'true' if the delivery is to be made to a residentiallocation. This includes private residences, apartments,churches, schools, camps, condominiums, country clubs,estates, farms, mini-storage warehouses, rectories,convents and other such locations. The 'Guaranteed By 5'Delivery Option is not available with ResidentialDelivery. Residential Delivery and Construction SiteDelivery cannot be selected together. Non-CommercialPickup/Delivery and Residential Delivery cannot beselected together.Set to 'true' if the pickup or delivery is to a noncommercial location. This includes schools, churches,camps, country clubs, estates, farms, mini-storagewarehouses, rectories, convents, prisons, military basesand other such locations. The 'Guaranteed By 5' DeliveryOption is not available with Non-CommercialPickup/Delivery. Non-Commercial Pickup/Delivery andResidential Delivery cannot be selected together. NonCommercial Pickup/Delivery and Construction SiteDelivery cannot be selected together.Set to 'true' if the carrier will be required by shipperand/or consignee to go through a security inspectionprocess in order to perform pickup or delivery inlocations such as, but not limited to airports, chemicalplants, military bases, ports, prisons, and other public orprivate facilities. The 'Guaranteed By 5' Delivery Optionis not available with Security Inspection.Number of pieces included with the shipment. This fieldis usually not required and if it is required then an errormessage will be returned indicating that it is required.5 MaxshipmentInfo.numHa StringndlingUnitsConditional5 MaxshipmentInfo.cubic StringFeetConditionalNumber of Handling Units included with the shipment.This field is usually not required and if it is requiredthen an error message will be returned indicating that itis required.Cubic Feet included with the shipment. This field isusually not required and if it is required then an errormessage will be returned indicating that it is required.99999.99 is MaxvalueshipmentInfo.densi StringtyConditional999.99 is Max value14Density of the shipment. This field is usually notrequired and if it is required then an error message willbe returned indicating that it is required.

PathType/Required/Size DescriptionshipmentInfo.overL StringengthOptionalsee list of validvaluesshipmentInfo.addit StringionalCargoLiabilityOptionalUsed to describe the longest dimension of the shipment:omit this field or pass a blank if the longest length is lessthan 8'. Enter 'OVL8' if the longest dimension is greaterthan or equal to 8' but less than 12'. Enter 'OVL12' if 12' but 16'. Enter 'OVL16' if 16' but 20'. Enter'OVL20' if 20' but 24'. Valid values are: omitted field,'', 'OVL8', 'OVL12', 'OVL16', 'OVL20'. The 'Guaranteed By5' Delivery Option is not available with any non-blankOverlength option.Used to request Additional Cargo Liability insurance.Valid values must be a positive number that matchesthis pattern: '999999.99'999999.99 is MaxvaluedeliveryOptionStringOptionalsee list of validvaluesEnter 'Standard' if you want the Rate Quote results toonly provide a Rate Quote for 'Standard' delivery. Enter'GuaranteedBy5' if you want the Rate Quote results toonly provide a Rate Quote for 'Guaranteed By 5 PM'delivery. Enter 'All' if you want the Rate Quote results toprovide a Rate Quote for 'Standard' delivery and for'Guaranteed By 5 PM' delivery. Valid values are:'Standard' or 'GuaranteedBy5' or 'All'. If this field isomitted or blank then 'Standard' will be used.15

Response FieldsPathTypeDescriptionquoteLocationsObjectMarks the start of a nested JSONobject called Quote Locations.This object holds the Shipperand Consignee addresses andcorresponding Service Centers.The descendant fields arealways available in theresponse unless they are null.quoteLocations.originCityStringThe origin city of the shipment.quoteLocations.originStateStringThe origin state of theshipment. (2 character stateabbreviation in capital letters)quoteLocations.originZipStringThe origin zip of the shipment.quoteLocations.originServiceCe StringnterThe origin Service Center of theshipment.quoteLocations.destinationCity StringThe destination city of theshipment.quoteLocations.destinationStat StringeThe destination state of theshipment. (2 character stateabbreviation in capital letters)quoteLocations.destinationZipThe destination zip of theshipment.StringquoteLocations.destinationServ StringiceCenterThe destination Service Centerof the shipment.quoteDetailsObjectMarks the start of a nested JSONobject called Quote Details. Thisobject holds one off detailssupplied with the request andresulting calculations forEstimated Service Days andEstimated delivery Date. Thedescendant fields are alwaysavailable in the response unlessthey are null.quoteDetails.rateQuoteNumberStringThe resulting Rate QuoteNumber unique to the resultingRate Quote. This Rate Quote canbe searched for and viewed inRate Quote history from onStringThe Delivery Option suppliedwith the request.16

he 'totalCharge' field is thegrand total amount of the ratequote. If you requested aStandard 'deliveryOption' thenthis amount will be the grandtotal for the 'Standard' deliveryoption. If you requested the'GuaranteedBy5' deliveryOptionthen this amount will be thegrand total for the 'GuaranteedBy 5 PM' delivery option.Combine all the chargeamounts in theaccessorialCharges array withQuote Details: subtotal,deficitCharge, discountAmountand fuelSurcharge and theresult will be the totalChargefor the Standard Delivery. Thedifference between this resultand the 'totalCharge', if any, isthe charge for the 'GuaranteedBy 5 PM' Delivery option.quoteDetails.subtotalStringThe 'subtotal' is the total of thesummation all the chargeamounts in the gThe charge associated with thedifference in weight used tobump freight to a higher weightgroup which will produce alower rate cwt.quoteDetails.discountAmountStringThe discounted amount appliedto the given shipment. Note thatthe 'Discount Amount' is shownas a positive amount - but it issubtracted from the totalFreight Charges.quoteDetails.fuelSurchargeStringFuel surcharges is a chargeapplied to cover a portion of thefuel costs.quoteDetails.accountNumberStringThe Account Number suppliedwith the request.quoteDetails.paymentTypeStringThe Payment Type suppliedwith the request.quoteDetails.customerTypeStringThe Customer Type suppliedwith the request.17

PathTypeDescriptionquoteDetails.shipDateStringThe Ship Date (yyyy-MM-dd)supplied with the request.quoteDetails.numPiecesStringThe Number of Pieces suppliedwith the request.quoteDetails.numHandlingUnitsStringThe Number of Handling Unitssupplied with the request.quoteDetails.cubicFeetStringThe Cubic Feet supplied withthe request.quoteDetails.densityStringThe Density supplied with therequest.quoteDetails.estimatedServiceD StringaysThe Estimated Service Dayscalculated by Averitt during theRate Quote.quoteDetails.estimatedDelivery StringDateThe Estimated Delivery Date(yyyy-MM-dd) calculated byAveritt during the Rate Quote.quoteDetails.guaranteedBy5Tota StringlChargeThe guaranteedby5 total charge.This field is only returned whenthe 'All' delivery option is sentin request. This field returns therate quote for theguaranteedby5 option, whenavailable. If a guaranteedby5rate quote is not available,given the request data, then thisfield will show 0.00.quoteDetails.guaranteedBy5esti StringmatedDeliveryDateThe guaranteedby5 estimateddelivery date. This field is onlyreturned when the 'All' deliveryoption is sent in request and isonly valid if theguaranteedBy5TotalCharge fieldis not 0.00.commodities[]Marks the start of an Array ofShipment Details that shows thefreight class, weight, rate, andcharge per line item supplied inthe request. The descendantfields are always available inthe response unless they arenull. The 'commodities' arraywill have the same elements asthe data supplied in the input:shipmentInfo.items array.18Array

ngThe class supplied in theresponse, for this line item, willbe echoed in format 'Class 50'.Furthermore, if Averittdetermines that the rate class ifdifferent than the suppliedfreight class then a message willbe appended as follows ' (Ratedas Class xx)' where xx isreplaced with the freight classthe line was determined to be.commodities[].shipmentWeightStringThe weight supplied in theresponse, for this line item, willbe echoed.commodities[].rateStringThe system calculated rate per100 pounds, for this line item. Ifthe entire shipment is subject toa minimum charge then thisfield will show two dashes asfollows '--' and the 'Charge' fieldwill read 'Min. Charge'.commodities[].chargeStringThe system calculated chargefor this line item. If the entireshipment is subject to aminimum charge then this fieldwill read 'Min. Charge' and the'Rate' field will show two dashesas follows '--'.quoteInformation[]ArrayMarks the start of an Array ofQuote Information dataelements (description/valuepairs) that shows one offinformation that comes fromthe rate quote engine.quoteInformation[].description StringThe following is a complete listof possible values for the'description' field: 'TotalWeight', 'Deficit Amount','Discount Factor', 'AdditionalCargo Liability', 'Tariff', 'RateBase', 'Gross Minimum', 'QuoteDate/Time'.19

he value that correspond tothe 'description' field. For 'TotalWeight' this will be the sum ofall weight amounts provided inthe freight items. For DeficitAmount this will be in pounds.For 'Discount Factor' this will bethe percent off of the freightcharges provide as a discount.For 'Additional Cargo Liability'this will be the additionalliability amount from therequest. If there is a 'Tariff' thenthe name of it will be shown.'Quote Date/Time' is in ISO 8601format: Marks the start of an Array ofAccessorial Charges(description/value pairs) thatshows some of the amounts thatgo into the Grand Total RateQuote amount.accessorialCharges[].descripti StringonA charge applied whenadditional services areperformed such as insidedelivery. There are alsoseparate line item chargesapplied to cover a portion of thecost to pickup or delivery tohigh cost areas such as NewYork City.accessorialCharges[].valueStringThe value that correspond tothe 'description' field.messageStringIf there is a validation errordetermined by the backend API,then the Message field willcontain the error message andwill be the only field returnedin the response. This field willbe returned with an HTTPstatus code of 422.20

HTTP status codesStatus codeMeaning201 CreatedThe rate quote has been created successfully.422 Bad RequestThe user input was missing or invalid.500 Internal Server ErrorThere was an unexpected server error occurredprocessing the user’s request.21

Error MessagesA 422 Unprocessable Entity response will be returned when the response data is invalid.Example of a unsuccessful response (just message isreturned),{"message" : "The class field must be specified and not blank if a weight is given.Error found on shipmentInfo:items line: 1."}Possible error messagesmessageThe Account Number field is missing and it is required input.The Account Number field contains blank input and it must contain a 7 digit string.The Account Number field is invalid; it must contain a 7 digit string. Your supplied AccountNumber is: '" input.getAccountNumber() "' Length " input.getAccountNumber().length());The Origin City field is missing and it is required inputThe Origin City field is blank and it must contain a valid City.The Destination City field is missing and it is required inputThe Destination City field is blank and it must contain a valid City.The Origin State field is missing and it is required inputThe Origin State field is blan

The LTL Rate Quote API follows standard HTTP and REST conventions in its use of HTTP verbs. Only the POST is used for this service. Verb Usage POST Used to create rate quote. API Key Requests to create a LTL Rate Quote require authentication using an API key as a URI query parameter. See example request below. LTL Rate Quote Syntax/Example