GetRates Method
Calculates postage rates to ship a package via the RequestedService .
Syntax
uspsrates.getRates([callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
For domestic rate requests, this method allows you to calculate how much domestic shipping will cost to mail a package with a certain size and weight, from SenderZipCode to RecipientZipCode by Express Mail, Priority Mail, First-Class Mail, Parcel Post, Media Mail, Library Mail, or as Bound Printed Matter.
Domestic rate requests use values for the following properties:
- RequestedService (required)
- SenderZipCode (required)
- RecipientZipCode (required)
- PackageWeight (required)
- PackageSize (required)
- PackageLength (required for large packages)
- PackageWidth (required for large packages)
- PackageHeight (required for large packages)
- PackageGirth (required for irregular packages)
- PackageType (optional)
- Machinable (optional)
- ServiceListNetCharge
- ServiceCommitments
- ServiceType
- ServiceTypeDescription
- ServicePackagingType
- ServiceMaxDimensions
- ServiceMaxWeight