LTL Rate: References
POST https://api.ushipsandbox.com/v2/raterequests
Provide specific and accurate rate request information for Service Providers to provide the most accurate rates.
Service Providers respond to the notification with bookable rates.
Although Optional the following fields are important to avoid REBILLS
Accessorial values associated with Pickup and Delivery
- These options should be selectable in integrators platform during shipping flow
Address Type i.e. BusinessWithLoadingDockOrForklift
Response: Upon successful call a 201 code will be returned, and the rateRequestId will be located in the Response Headers under Location
{
"route": {
"items": [
{
"address": {
"streetAddress": "1000 Main Street",
"alternateStreetAddress": "Bldg 8, Suite 300",
"majorMunicipality": "Santa Barbara",
"postalCode": "93108",
"stateProvince": "CA",
"country": "US",
"type": "BusinessWithLoadingDockOrForklift"
},
"timeFrame": {
"earliestArrival": "2014/10/20",
"latestArrival": "2014/10/20",
"timeFrameType": "on"
},
"accessorials": [
"inside",
"liftgateRequired"
],
"contact": {
"name": "JaneSmith",
"companyName": "CommercialGoodsGalore",
"phoneNumber": "1234567890"
}
},
{
"address": {
"streetAddress": "1000 2nd Street",
"alternateStreetAddress": "Apt 233",
"majorMunicipality": "Aransas Pass",
"postalCode": "78336",
"stateProvince": "TX",
"country": "US",
"type": "BusinessWithLoadingDockOrForklift"
},
"accessorials": [
"inside",
"liftgateRequired",
"callAhead"
],
"contact": {
"name": "JaneSmith",
"companyName": "CommercialGoodsGalore",
"phoneNumber": "1234567890"
}
}
]
},
"items": [
{
"commodity": "NewCommercialGoods",
"unitCount": 1,
"packaging": "Pallets",
"weightInGrams": 226796,
"widthInMeters": 0.9144,
"lengthInMeters": 1.2191999999999998,
"heightInMeters": 1.8288,
"freightClass": 77.5,
"stackable": true,
"hazardous": false,
"handlingUnit": "Pallets48x40Inches",
"title": "Apple Products",
"description": "Apples on Pallet"
}
],
"thirdPartyId": "String for Third Party Identifier"
}
Route Object
Although an optional field, it's strongly suggested that integrators use this field and add the proper AddressType in order to receive a precise rate. You can view valid AddressTypes here: Address Type
earliestArrival and latestArrival MUST be the same date and timeFrameType must be set to "on." This is due to the fact that LTL carriers need a single day window and not a range. Failure to set this properly will result in an empty rate set when rates are retrieved. Please reach out to API support with any questions at api-support@uship.com.
- The "streetAddress" is required
- If no address type is specified, the default is "Residence" where the "companyName" field is not required in the contact object.
- The pick up time frame is the only one available and is required. Do not specify the delivery time frame.
- The only time frame type you can specify for pick up is "on" where the time frame dates must match exactly.
- Either specify the zip codes or the latitude and longitude for both pick up and delivery addresses.
Commodity Object
Field | Type | Description |
---|---|---|
commodity | String | Specify the LTL Freight commodity found in the reference enumeration section below. "Commodity Codes". Required. |
unitCount | Integer | If no value is provided, the default is set to one (1). |
handlingUnit | String | The method in which the unit is handled by a carrier during transport. If a number of packages have been secured to a single pallet and cannot be separated during transport, the quantity is referred to as (1) handling unit. Required. Dimensions: Include pallets and other packaging materials. Example: A shipment containing 10 boxes stretch-wrapped to a single pallet should be described as (1) handling unit. A shipment containing 10 un-palletized “loose” boxes should be described as (10) handling units. Valid example string for a handling unit "Pallets48x40Inches". A lookup will be available to get all valid values. |
stackable | Boolean | The item has flat surfaces and can sustain the weight of another object.
|
lengthInMeters | Decimal | The length of the item or unit in meters. Required unless freight class is supplied. |
heightInMeters | Decimal | The height of the item or unit in meters. Required unless freight class is supplied. |
weightInGrams | Integer | The total weight of the item or unit in grams. Required unless freight class is supplied. |
freightClass | Decimal | Carriers use freight classes to calculate shipping costs. They are defined in the National Motor Freight Classification Guide. If you are unsure of your shipment's freight class, simply enter the dimensions and weight for a rate request. A lookup will be available to get all valid values. Freight class is determined by four factors:
|
hazardous | Boolean | A substance or material may be classified as hazardous if the transportation of the material in a particular amount and form poses an unreasonable risk to health and safety or property. Hazardous materials are defined by the U.S. Department of Transportation in accordance with the Federal Hazardous Material Law and require special handling and documentation. For more general information, go to the U.S. DOT website at http://www.phmsa.dot.gov/hazmat.
|
Pickup/Delivery Accessorials
Field | Type | Description |
---|---|---|
inside | Boolean | Inside pickup/delivery
|
liftgateRequired | Boolean | Liftgate service at pickup/delivery. If a liftgate is required for the shipment, it must be specified especially when the address type is “Residence” or “BusinessWithoutLoadingDock”. Providing the service requires extra charge.
|
callBeforeArrival | Boolean | The Shipping Customer requires the Service Provider to call the specified contact at the delivery address before arriving at the location. Providing this notice requires extra charge.
|
appointmentRequired | Boolean | The Shipping Customer requires the Service Provider to set an appointment for when to deliver. Providing this service requires extra charge.
|
Additional Services Accessorials
Field | Type | Description |
---|---|---|
protectFromFreezing | Boolean | Protect from freezing
|
blindShipmentCoordination | Boolean | Blind shipment coordination
|
sortandSegregate | Boolean | Sort & segregate
|
ThirdPartyID
Optional unique string identifier used in conjunction with the X-Affiliate header to tie the request to a unique identifier. Useful for uShip API consumers and third parties to identify rate requests in their own applications and systems.
Reference Enumerations: Commodity Codes
Business and Industrial Goods Categories
String |
---|
WoodPaperProducts |
LiquidsGasesChemicals |
StoneMetalsMinerals |
CommoditiesDryBulk |
GeneralFreight |
MixedFreight |
Utilities |
PharmaceuticalProducts |
Fertilizers |
PlasticsRubber |
TextilesLeather |
MiscellaneousManufacturedProducts |
OtherBusinessIndustrialGoods |
PaperProducts |
LogsandOtherWoodintheRough |
WoodProducts |
PaperorPaperboardArticles |
PrintedProducts |
LiquidsGases |
Chemicals |
CrudePetroleumOil |
WaterWell |
GasolineandAviationTurbineFuel |
FuelOils |
ChemicalProductsandPreparationsnec |
BuildingMaterials |
MachineryLargeObjects |
ElectronicandOtherElectricalEquipmentandComponentsandOfficeEquipment |
PrecisionInstrumentsandApparatus |
CoalorCoke |
MonumentalorBuildingStone |
NaturalSands |
GravelandCrushedStone |
NonMetallicMineralsnec |
MetallicOresandConcentrates |
CoalandPetroleumProductsnec |
NonMetallicMineralProducts |
Metalsheetscoilsrolls |
BaseMetalinPrimaryorSemiFinishedFormsandinFinishedBasic |
ArticlesofBaseMetal |
Vehicle, Boat, Food & Agricultural Goods Categories
String |
---|
VehicleParts |
BoatParts |
RefrigeratedFood |
MeatFishSeafood |
CerealGrainsincludingseed |
AnimalFeedProductsofAnimalOrigin |
MilledGrainProductsPreparationsandBakeryProducts |
Beverages |
AlcoholicBeverages |
OtherPreparedFoodstuffsandFatsandOils |
TobaccoProducts |
OtherFoodAgriculture |
LTL Freight Categories
String |
---|
NewCommercialGoods |
UsedCommercialGoods |
WineLiquorBeerSpirits |
NonPerishableFoodsBeverages |
OtherLessthanTruckloadGoods |
Handling Units
Valid String Values |
---|
Boxes |
Cartons |
Crates |
Drums |
Bags |
Bales |
Bundles |
Cans |
Carboys |
Carpets |
Cases |
Coils |
Cylinders |
Loose |
NoPackagingRequired |
PackagingHelpRequired |
Pallets48X40Inches |
Pails |
Reels |
Rolls |
TubesPipes |
Other |