Compare shipping rates
compare_shipping_ratesCompare live shipping rates for one parcel across every carrier available on the SIGNED-IN account (Canada Post, Purolator, UPS, FedEx and others), at the prices of that account. Returns each carrier and service with its total price, currency and estimated transit days. Requires the user to connect their account; for someone without an account use get_shipping_quote, which needs no sign-in. Prices are live and account-specific; do not cache them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width_cm | Yes | Parcel width in centimetres. | |
| height_cm | Yes | Parcel height in centimetres. | |
| length_cm | Yes | Parcel length in centimetres. | |
| to_postal | Yes | Destination postal or ZIP code, e.g. "M5V 2T6". | |
| weight_kg | Yes | Parcel weight in kilograms. Must be greater than 0. | |
| to_country | No | Destination country, ISO alpha-2. Defaults to "CA". | |
| from_postal | Yes | Origin postal or ZIP code, e.g. "H2X 1Y1". | |
| residential | No | True if delivering to a home address. Affects price on some carriers. | |
| from_country | No | Origin country, ISO alpha-2. Defaults to "CA". |