Rate Estimate Web Service Reference Guide
 

The Rate Estimate Web Service provides a way for developers to pass a token number and in return receive a Rate Estimate and other output for use in a client-side or local program. The service is a SOAP-based web service. The file contains WSDL,Sample code(C#) and element list.
If you have questions or comments, email us.

Url : http://wsportal.aaacooper.com:8188/wsGenRateEstimate.wsdl


Web Service Description Language:
Web Service Elements:
RateEstimateRequest Elements
Element Name Element Description Required Constraint or Note Length
Token Token Number Yes Authentication Credentials required 36
CustomerNumber Customer Number    If passed blank, Estimate Number will not be generated. 9
OriginCity Origin city name Yes   25
OriginState Origin state postal code Yes U.S. Postal abbreviation 2
OriginZip Origin zip code Yes   6
OriginCountryCode Origin country code Yes Pass United States as USA, Canada as CAN 3
DestinationCity Destination city name Yes   25
DestinationState Destination state postal code Yes U.S. Postal abbreviation 2
DestinationZip Destination zip code Yes   6
DestinCountryCode Destination country code Yes Pass United States as USA, Canada as CAN 3
WhoAmI Customer Number is the S, C, or 3 Yes S(Shipper), C(Consignee), 3(Third Party) 1
BillDate Bill Date Yes MMDDYY or MMDDYYYY format 8
CODAmount No longer Used   No longer Used
CODPayType No longer Used   No longer Used
CODFeePaidBy No longer Used   No longer Used
FullCoverage Full Value Coverage   Pass Y if Full value Coverage is needed 1
FullCoverageAmount Full Coverage Amount, Declared Value   Pass value as XXXXX format 5
PrePaidCollect Mode of Payment Yes Value: P (Prepaid), C (Collect) 1
TotalPalletCount Total Pallet Count     3


Accessorial Line Element
Element Name Element Description Required Constraint or Note Length
AccCode Accessorial Code   List of Accessorial Codes 3


RateEstimateRequestLine Elements
Element Name Element Description Required Constraint or Note Length
Weight Weight Yes Total actual weight of all items must be at least 2 lbs. 5
Class Class Yes   4
HandlingUnits Handling Units     5
HandlingUnitType Handling Unit Type   List of Handling Unit types 10
HazMat Hazardous material   Pass X if shipment is Hazardous else leave blank. 1
CubeU Cubic unit measurement   Pass IN for inches (Currently accepts only inches) 2
Length Length * *Pass in inches if over 96" 4
Height Height   Pass in inches 4
Width Width   Pass in inches 4


The Rate Estimate Web Service Response may show separate from the Rate Estimate Total Charges Amount an Action Guaranteed Day (AGD) Delivery Fee. The AGD fee is not included in the response objects’ Total Charges Amount as the fee is an add-on fee requested at pickup time. Circumstances that prevent an AGD fee from being shown when the Rate Estimate Web Service Request object is received by the web service are:
  • Route involves an interline carrier.
  • Any one of the listed Accessorial Codes requested will prevent an AGD fee from being provided. See List of Accessorial Codes.
Although when the fee is present in a Rate Estimate Web Service Response object, an AGD service will not be provided at pickup time when the actual shipment is during holidays or limited operations days. See Current Schedule

Accessorial Codes

Attached is the list of Accessorial Codes that needs to be passed to the web service.

Accessorial Name Accessorial Code Explanation
Camp Delivery CAD When carrier will perform the delivery at a camp site.
Camp Pickup CAP When carrier will perform the pickup at a camp site.
Country Club Delivery CCD When carrier will perform the delivery at a country club site.
Church Delivery CHD When carrier will perform the delivery at a church site or any place of worship site.
Church Pickup CHP When carrier will perform the pickup at a church site or any place of worship site.
Construction Site Delivery CSD When carrier will perform the delivery at a construction site. Construction Site is defined as the site of any construction of buildings, roads or bridges or other structures including the entire property upon which the construction is taking place, and delivery to any facility (such as warehouses, depots, supply houses or similar facilities) located on such property.
Construction Site Pickup CSP When carrier will perform the pickup at a construction site. Construction Site is defined as the site of any construction of buildings, roads or bridges or other structures including the entire property upon which the construction is taking place, and delivery to any facility (such as warehouses, depots, supply houses or similar facilities) located on such property.
Excess Length >= 96in (8FT) EXL When your shipment contains one or more articles that are equal to or greater than 8 feet in length. Input length in inches in the appropriate box.
Hazmat Fees HMF When carrier will accept shipments that contain hazardous materials.
Inside Delivery ISD When the unloading of freight is not at a position immediately adjacent to the vehicle. Inside Delivery is not provided at a residence.
Inside Pickup ISP When loading of freight is not at a position immediately adjacent to the vehicle. Inside Pickup is not provided at a residence.
Liftgate Delivery LGD When a hydraulic Liftgate is needed to complete the delivery.
Liftgate Pickup LGP When a hydraulic Liftgate is needed to complete the pickup.
Military Installation Delivery MID When carrier will perform the delivery at a military installation site.
Military Installation Pickup MIP When carrier will perform the pickup at a military installation site.
Mine Delivery MND When carrier will perform the delivery at a mine site. Mine Site is defined as the site of any pit, excavation, shaft or deposit at which coal, ore or minerals is, has been, or will be extracted. Such site or "mine" shall include the entire property upon which the mine is located, and delivery to any facility (such as mine warehouses, mine deposits, mine supply houses, mine tipples or similar receiving facilities) on such property.
Mine Pickup MNP When carrier will perform the pickup at a mine site. Mine Site is defined as the site of any pit, excavation, shaft or deposit at which coal, ore or minerals is, has been, or will be extracted. Such site or "mine" shall include the entire property upon which the mine is located, and pickup at any facility (such as mine warehouses, mine deposits, mine supply houses, mine tipples or similar receiving facilities) on such property.
Notify Charge NCM When consignee needs to be notified and have appointment established for delivery to be completed. Notify charge is not applicable for residential Pickup/Delivery.
Protect From Freezing PFF When carrier will furnish protective heater service against freezing subject to suitable equipment being available and provided that the shipper states specifically on the Bill of Lading "Heater SERVICE REQUIRED" or "PROTECT FROM FREEZING".
Pier Delivery PRD When shipments are delivered to a pier or wharves.
Pier Pickup PRP When shipments are picked up a pier or wharves.
Prison Site Delivery PSD When carrier will perform the delivery at a prison site or any place of incarceration site.
Prison Site Pickup PSP When carrier will perform the pickup at a prison site or any place of incarceration site..
Restricted Access Delivery RAD When your shipment will be delivered to a location with limited access, involving limited or no unloading facilities and/or having security entrance delays.
Restricted Access Pickup RAP When your shipment will be picked up from a location with limited access, involving limited or no unloading facilities and/or having security entrance delays.
Residential Delivery RSD When the shipment is to be delivered to a private residence. Inside Delivery will not be performed at a residence.
Residential Pickup RSP When your shipment will be picked up from a location with limited access, involving limited or no unloading facilities and/or having security entrance delays.
Resort Delivery RTD When carrier will perform the delivery at a resort site.
Resort Pickup RTP When carrier will perform the pickup at a resort site.
School Delivery SCD When carrier will perform the delivery at a school site.
School Pickup SCP When carrier will perform the pickup at a school site.
Self-Storage Delivery SSD When carrier will perform the delivery at a self-storage site.
Self-Storage Pickup SSP When carrier will perform the pickup at a self-storage site.
Transfer Of Lading TOL When a shipment requested be picked up or delivered cannot be completed with the same vehicle that will or did transport the shipment over the highway.
Utility Site Delivery USD When carrier will perform the delivery at a utility site. Utility Site is defined as a power generation station, whether nuclear, thermal, hydroelectric or fossil fuel, or pumping station.
Utility Site Pickup USP When carrier will perform the pickup at a utility site. Utility Site is defined as a power generation station, whether nuclear, thermal, hydroelectric or fossil fuel, or pumping station.


Handling Unit Types

Attached is the list of Handling Unit types.

Handling Unit Type
Pallets (Preferred over Skids)
Cartons
Drums
Rolls
Bundles
Mixed
Other (Use if handling unit type is not listed)

 
Sample Code (C#):
 
Sample xml Request :