EstimateRates
Calculates estimated shipping rates without full shipment details.
Procedure Specific Information
Calculates estimated shipping rates without full shipment details. Requires origin and destination addresses, weight, and at least one carrier Id. Optional parameters include package dimensions, delivery confirmation type, and address residential indicator. The procedure is executed as below:
EXEC EstimateRates CarrierIds = 'se-28529731', FromCountryCode = 'US', FromPostalCode = '78756', FromCityLocality = 'Austin', FromStateProvince = 'TX', ToCountryCode = 'US', ToPostalCode = '90001', ToCityLocality = 'Los Angeles', ToStateProvince = 'CA', WeightValue = '1.0', WeightUnit = 'pound', ShipDate = '2024-01-15T00:00:00Z'
Input
| Name | Type | Description |
| CarrierIds | String | A comma-separated list of carrier Ids to estimate rates for (e.g., se-28529731,se-12345). |
| FromCountryCode | String | The two-letter ISO 3166-1 country code of the origin. |
| FromPostalCode | String | The origin postal code. |
| FromCityLocality | String | The origin city or locality. |
| FromStateProvince | String | The origin state or province. |
| ToCountryCode | String | The two-letter ISO 3166-1 country code of the destination. |
| ToPostalCode | String | The destination postal code. |
| ToCityLocality | String | The destination city or locality. |
| ToStateProvince | String | The destination state or province. |
| WeightValue | Double | The shipment weight value. |
| WeightUnit | String | The weight unit.
The allowed values are pound, ounce, gram, kilogram. |
| ShipDate | Datetime | The ship date and time in ISO 8601 format (e.g., 2018-09-23T15:00:00.000Z). |
| DimensionsUnit | String | The dimensions unit.
The allowed values are inch, centimeter. |
| DimensionsLength | Double | The package length. |
| DimensionsWidth | Double | The package width. |
| DimensionsHeight | Double | The package height. |
| Confirmation | String | The delivery confirmation type.
The allowed values are none, delivery, signature, adult_signature, direct_signature, delivery_mailed, verbal_confirmation, delivery_code, age_verification_16_plus. |
| AddressResidentialIndicator | String | Indicates whether the destination address is residential.
The allowed values are unknown, yes, no. |
Result Set Columns
| Name | Type | Description |
| RateType | String | The rate type. |
| CarrierId | String | The carrier Id. |
| ServiceCode | String | The service code. |
| ServiceType | String | The service type. |
| CarrierCode | String | The carrier code. |
| CarrierNickname | String | The carrier nickname. |
| CarrierFriendlyName | String | The carrier display name. |
| Zone | Integer | The shipping zone. |
| PackageType | String | The package type. |
| CarrierWeight | Double | The carrier weight. |
| DeliveryDays | Integer | The estimated delivery days. |
| CarrierDeliveryDays | Integer | The carrier delivery days. |
| GuaranteedService | Boolean | Indicates whether the service is guaranteed. |
| EstimatedDeliveryDate | Datetime | The estimated delivery date. |
| ShipDate | Datetime | The ship date. |
| NegotiatedRate | Boolean | Indicates whether a negotiated rate was applied. |
| TrackableService | Boolean | Indicates whether the service supports tracking. |
| ValidationStatus | String | The validation status of the rate. |
| DisplayScheme | String | The display scheme. |
| ShippingAmount | Decimal | The shipping cost. |
| ShippingAmountCurrency | String | The shipping cost currency code. |
| InsuranceAmount | Decimal | The insurance cost. |
| InsuranceAmountCurrency | String | The insurance cost currency code. |
| ConfirmationAmount | Decimal | The confirmation cost. |
| ConfirmationAmountCurrency | String | The confirmation cost currency code. |
| OtherAmount | Decimal | Any other charges. |
| OtherAmountCurrency | String | The other charges currency code. |
| RequestedComparisonAmount | Decimal | The requested comparison amount. |
| RequestedComparisonAmountCurrency | String | The requested comparison amount currency code. |
| RateDetails | String | The rate details as a JSON array. |
| RateAttributes | String | Rate attributes such as fastest or best_value as a JSON array. |
| WarningMessages | String | Any warning messages as a JSON array. |
| ErrorMessages | String | Any error messages as a JSON array. |