shipments

Get shipping rates

Retrieves shipping rates for the specified shipping details. Use this endpoint to compare rates across different carriers and services before creating a label.

post/shipments/getrates

Request body

carrierCodestring required

Carrier code to get rates from

serviceCodestring nullable

Specific service code (optional)

packageCodestring nullable

Package type code (optional)

fromPostalCodestring required

Origin postal code

toCountrystring required

Destination country (two-letter ISO code)

toPostalCodestring required

Destination postal code

toStatestring

Destination state (required for UPS)

toCitystring

Destination city (optional)

confirmation'none' | 'delivery' | 'signature' | 'adult_signature' | 'direct_signature'

Delivery confirmation type

residentialboolean

Whether destination is residential

Example request

{
  "carrierCode": "fedex",
  "fromPostalCode": "78703",
  "toCountry": "US",
  "toPostalCode": "20500",
  "toState": "DC",
  "toCity": "Washington",
  "weight": {
    "value": 24,
    "units": "ounces"
  },
  "dimensions": {
    "length": 7,
    "width": 5,
    "height": 6,
    "units": "inches"
  },
  "confirmation": "delivery"
}

Response

List of available shipping rates

serviceNamestring

serviceCodestring

shipmentCostnumber

otherCostnumber

Example response

[
  {
    "serviceName": "FedEx Ground®",
    "serviceCode": "fedex_ground",
    "shipmentCost": 8.25,
    "otherCost": 0.33
  }
]