Get rates
Returns available shipping rates for a shipment from multiple carriers, sorted by price.
Parameters
Request Body
from_address
object
Required
Origin address (ID or inline object)
to_address
object
Required
Destination address (ID or inline object)
parcel
object
Required
Package dimensions and weight. Required for accurate rate calculation.
Can be either an existing parcel ID or an inline object with dimensions.
carrier_account_ids
array
Filter rates by specific carrier account IDs (recommended).
Takes precedence over `carriers` parameter.
Use this to select between system accounts and your BYOCA accounts.
Get available accounts from `GET /v1/carrier-accounts`.
carriers
array
Filter rates by carrier name (e.g., USPS, FEDEX).
Ignored if `carrier_account_ids` is provided.
Note: If you have multiple accounts for the same carrier (system + BYOCA),
use `carrier_account_ids` instead for precise control.
services
array
Filter rates by service. Accepts both:
- Service names: "Priority Mail", "UPS Ground"
- Service codes: "usps_priority", "ups_ground"
options
object
Returns
200
Rates calculated successfully
400
Invalid request data
401
Authentication required
404
Address not found
Related
Labels
POST/api/v1/rates