Rates
Rate shop across your configured carrier accounts to find the best shipping options for a given package and destination.
Get Rates
POST
/api/ratesGet shipping rates from one or more carrier accounts.
Requiredrates:read
Queries one or more carrier accounts for available shipping rates based on the package details, origin, and destination. Results are returned sorted by price.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
carrier_account_ids | string[] | No | Specific carrier accounts to query (queries all if omitted) |
ship_from | object | Yes | Origin address |
ship_to | object | Yes | Destination address |
parcels | object[] | Yes | Package dimensions and weight |
ship_date | string | No | Requested ship date (ISO 8601, defaults to today) |
Address Object
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Contact name |
street1 | string | Yes | Street address line 1 |
street2 | string | No | Street address line 2 |
city | string | Yes | City |
state | string | Yes | State or province code |
zip | string | Yes | Postal code |
country | string | Yes | Two-letter country code |
Parcel Object
| Field | Type | Required | Description |
|---|---|---|---|
length | number | Yes | Length |
width | number | Yes | Width |
height | number | Yes | Height |
weight | number | Yes | Weight |
unit | string | No | Weight unit: lb or kg (default: lb) |
dimension_unit | string | No | Dimension unit: in or cm (default: in) |
curl -X POST "https://api.orderly.dev/api/rates" \
-H "Authorization: Bearer ord_sk_..." \
-H "Content-Type: application/json" \
-d '{
"ship_from": {
"street1": "123 Warehouse St",
"city": "Newark",
"state": "NJ",
"zip": "07102",
"country": "US"
},
"ship_to": {
"street1": "456 Customer Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"parcels": [
{ "length": 12, "width": 8, "height": 6, "weight": 2.5 }
]
}'Response
{
"data": [
{
"carrier": "fedex",
"carrier_account_id": "uuid",
"service": "GROUND_HOME_DELIVERY",
"service_name": "FedEx Ground Home Delivery",
"rate": { "amount": 8.95, "currency": "USD" },
"estimated_days": 5,
"delivery_date": "2026-01-20"
},
{
"carrier": "ups",
"carrier_account_id": "uuid",
"service": "03",
"service_name": "UPS Ground",
"rate": { "amount": 9.50, "currency": "USD" },
"estimated_days": 4,
"delivery_date": "2026-01-19"
}
]
}