Description
The RateModel is an object that models the request for a rate. It contains properties for the data that is required to make a rate request.
Properties
| Property Name | Value | Description |
|---|---|---|
| Service | RateService Enumeration (required) |
The service type. The possible values for the RateService enumeration are:
|
| ZipOrigination | String (required) | ZIP Codes must be valid. Maximum characters allowed: 5 * |
| ZipDestination | String (required) | ZIP Codes must be valid. Maximum characters allowed: 5 * |
| Pounds | Integer (required) | Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). |
| Ounces | Integer (required) | Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). |
| Container | RateContainer Enumeration (required) |
Container is only applicable for Express Mail and Priority Mail. It will be ignored if specified with any other service type. The possible values for the RateContainer enumeration are:
|
| Size | RateSize Enumeration (required) |
Size of the package. For specific dimensions, refer to the U.S.P.S. Web Tools Technical Documentation for the Rate Calculator. The possible values for the RateSize enumeration are:
|
| Machinable | Boolean (optional) | Machinable applies only to Parcel Post. (Machinable criteria do not apply to Priority Mail, Express Mail, Bound Printed Matter, Library Mail, or Media Mail.) Machinable can be specified on service type ALL but it will only apply to the Parcel Post rate. |
| Zone | Integer (n/a) | Not used as an input for rate calculations. |
* The maximum character amounts allowed for some tags. If the user enters more than those amounts, an error will not be generated. The Web Tool will simply pass in the characters up to the maximum amount allowed and disregard the rest.
For further descriptions of the any of the fields, refer to the Rate Calculator technical guide on the U.S.P.S. Web Tools web site.
Current Version
1.0Return to Rate Calculator Service | Return to Services Available