Rates
The Rates API allows you to obtain shipping rate estimates based on specific shipment details, including service level, processing location, destination, and package weight.
Getting Shipping Rates
When you call the Rates API, we’ll return a simple response that includes the service_code, the shipping rate, and the currency_code. This gives you a quick snapshot of how much it’ll cost to ship using that specific service.
You can use the service_code to track or match up services in your own system, and the rate tells you the total shipping cost in the specified currency—so you have everything you need to make a decision or present pricing to your customers.
Property | Type | Description | Units |
---|---|---|---|
service_code | string | Code for the shipping service you want to rate (e.g., "STD") | |
processing_location | string | Location code where the shipment will be processed (e.g., "BUF") | JFK, BUF, SLC |
recipient_postal_code | string | Destination postal code | |
recipient_country_code | string | Destination country code (2-letter ISO format, e.g., "CA" | |
total_package_weight | string | Total weight of the shipment | e.g., LB |
weight_unit | string | Unit of measurement for the weight | LB |
Request
curl -X POST "https://client.brdrch.com/api/v1/rates" \
-u "cd3b3de84cc1ee040bf06512d233719c" \
-d '{}'
{
"service_code": "STD",
"processing_location": "JFK",
"recipient_postal_code": "V6B1A1",
"recipient_country_code": "CA",
"total_package_weight": 10,
"weight_unit": "LB"
}
Response
{
"service_code": "STD",
"rate": 4.55,
"currency_code": "USD"
}
Updated 9 days ago