/TransGuardian/Rates GET

Returns shipping rate quotes based on the shipping source & destination, package, and service parameters

URL

/TransGuardian/Rates

Verb

GET

Headers

Header	Data Type	Valid Values	Required	Description
Content-Type	string	application/json	YES	The format your data will be sent to our site.
X-DevKey	string	string	YES	The devkey assigned to the developer.

Input

NOTE: Variables to place in the query string of the request.

Parameter	Data Type	Valid Values	Description
AuthToken	string	Authentication Token returned from /TransGuardian/Authenticate call	Allows access to the TransGuardian service
CargoType	integer	Firearm-related Types 3 - Handguns, 4 - FirearmsNotHandguns Other Types 32 - GeneralCargoNotFragile	Indicates the type of cargo for the rate quote. Insured shipments require a type other than NoneSpecified (0)
Carriers	string	3 = FedEx, 7 = UPS, 9 = USPS, 10 = USPS Flat	Comma-separated list of carriers from which to request quotes, e.g. 3,7,9
DeclaredValue	decimal	positive #	Optional - The declared value for quoting insurance. Leave blank to exclude insurance from the quote.
FromCompany	string	string	The company name being shipped from. Required for Carrier 7 (UPS), otherwise optional
FromAddress1	string	string	The street address for the source of the package
FromAddress2	string	string	The street address for the source of the package
FromIsBusinessAddress	boolean	true and false	Is the address for the source of the package a business?
FromCity	string	string	The city for the source of the package
FromState	string	string	The 2-digit ISO state code for the source of the package
FromZip	string	string	The ZIP code for the source of the package
FromCountry	string	string	The 2-digit ISO country code for the source of the package
FromPhoneNumber	string	string	Optional - The phone number for the source of the package
InvoiceValue	decimal	positive #	The invoice value for the shipment. This is separate from the declared value and should reflect the amount a customer might be charged for the contents of the shipment
ListingClass	integer	0 = All, 1 = Overnight, 2 = Two Day, 4 = Three Day 8 = Ground, 16 = USPS First Class, 32 = USPS Priority Mail, 64 = Other	The shipping class selected from the item listing. NOTE: If 0 is selected, rates for all types of classes will be returned.
PackageDimX	decimal	positive #	The length of the package in inches. Required for PackageType=5 (CustomBox), otherwise optional
PackageDimY	decimal	positive #	The width of the package in inches. Required for PackageType=5 (CustomBox), otherwise optional
PackageDimZ	decimal	positive #	The height of the package in inches. Required for PackageType=5 (CustomBox), otherwise optional
PackageType	integer	1 - CarrierBox, 2 - CarrierLetter, 3 - CarrierTube, 4 - CarrierPak, 5 - CustomBox, 6 - UspsFlatRateWindowedEnvelope, 7 - UspsFlatRateCardboardEnvelope, 8 - UspsFlatRateSmallEnvelope, 9 - UspsFlatRateEnvelope, 10 - UspsFlatRateLegalEnvelope, 11 - UspsFlatRatePaddedEnvelope, 12 - UspsFlatRateSmallBox, 13 - UspsFlatRateBox, 14 - UspsFlatRateLargeBox, 15 - UspsFlatRateRegionalBoxA, 16 - UspsFlatRateRegionalBoxB, 17 - UspsFlatRateApo	The package type for the rate quote
SignatureType	integer	1 = None, 2 = DeliveryConfirmation, 3 = SignatureConfirmation 4 = AdultSignatureConfirmation,	Indicates the type of signature requested for the package
ShipDate	datetime	Valid ISO 8601 Date format	The date that the package will ship
ToCompany	string	string	The company name being shipped to. Rquired for UPS, otherwise optional.
ToAddress1	string	string	The street address for the destination of the package
ToAddress2	string	string	The street address for the destination of the package
ToIsBusinessAddress	boolean	true and false	Is the address for the destination of the package a business?
ToCity	string	string	The city for the destination of the package
ToState	string	string	The 2-digit ISO state code for the destination of the package
ToZip	string	string	The ZIP code for the destination of the package
ToCountry	string	string	The 2-digit ISO country code for the destination of the package
ToPhoneNumber	string	string	The phone number for the destination of the package. Required for some UPS destinations, otherwise optional
WeightOz	decimal	positive #	The weight (in ounces) of the package

Output

If the search parameters are not valid, you will receive a 400 BadRequest and a Message Response indicating the reason. If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as an array of serialized JSON.

Parameter	Data Type	Valid Values	Description
Carrier	integer	3 = FedEx, 7 = UPS, 9 = USPS, 10 = USPS Flat	The carrier for which the quote is provided
DeliveryDate	datetime	Valid ISO 8601 DateTime format	The delivery date and time provided for the quote. AM or PM delivery will include the estimated time of day.
ErrorMessages	Array of strings	Any array of strings, or null if not provided by the vendor	An array of strings indicating error messasges for the quote
FreightPrice	decimal	On success, a positive #, Otherwise 0	The freight portion of the rate quote
InsurancePrice	decimal	On success, a positive #. Otherwise 0	The insurance portion of the rate quote, if requested
Price	decimal	On success, a positive #. Otherwise 0	The total rate quote
PackageType	integer	1 - CarrierBox, 2 - CarrierLetter, 3 - CarrierTube, 4 - CarrierPak, 5 - CustomBox, 6 - UspsFlatRateWindowedEnvelope, 7 - UspsFlatRateCardboardEnvelope, 8 - UspsFlatRateSmallEnvelope, 9 - UspsFlatRateEnvelope, 10 - UspsFlatRateLegalEnvelope, 11 - UspsFlatRatePaddedEnvelope, 12 - UspsFlatRateSmallBox, 13 - UspsFlatRateBox, 14 - UspsFlatRateLargeBox, 15 - UspsFlatRateRegionalBoxA, 16 - UspsFlatRateRegionalBoxB, 17 - UspsFlatRateApo	The package type for the rate quote
Service	integer	1- NextDayEarlyAm, 2- NextDayAm, 3- NextDayPm, 4- TwoDayAm, 5- TwoDayPm, 6- ThirdDay, 7- GroundOrFirstClass	The carrier service for which the quote is provided
QuoteStatus	integer	0 - Failure, 1 - Success, 2 - Warning, 3 - Note	The status of the quote provided
ShipDate	datetime	Valid ISO 8601 DateTime format	The ship date requested for the price quote
SignatureType	integer	1 = None, 2 = DeliveryConfirmation, 3 = SignatureConfirmation 4 = AdultSignatureConfirmation,	The type of signature requirement for which the quote is provided. Note that this may be different than the type requested, due to requirements for certain carrier services
StatusMessages	Array of strings	Any array of strings, or null if not provided by the vendor	An array of strings indicating status messages for the quote