Get Rates

Retrieves shipping rates for the specified shipping details. The body of this request should specify the following attributes:

Name	Data Type	Description
`carrierCode`	string, required	Returns rates for the specified carrier.
`serviceCode`	string, optional	Returns rates for the specified shipping service.
`packageCode`	string, optional	Returns rates for the specified package type.
`fromPostalCode`	string, required	Originating postal code.
`fromCity`	string, optional	Originating city.
`fromState`	string, optional	Originating state.
`fromWarehouseId`	string, optional	Originating warehouse ID. The `fromCity` and `fromState` fields will take precedence over the `fromWarehouseId` field if all three are entered.
`toState`	string, optional	Destination State/Province. Please use two-character state/province abbreviation. Note this field is required for the following carriers: UPS
`toCountry`	string, required	Destination Country. Please use the two-letter ISO Origin Country code.
`toPostalCode`	string, required	Destination Postal Code.
`toCity`	string, optional	Destination City.
`weight`	Weight, required	Shipment's weight. Use Weight object.
`dimensions`	Dimensions, optional	Shipment's dimensions. Use Dimensions object.
`confirmation`	string, optional	The type of delivery confirmation that is to be used once the shipment is created. Possible values: `none`, `delivery`, `signature`, `adult_signature`, and `direct_signature`. `direct_signature` is available for FedEx only.
`residential`	boolean, optional	Carriers may return different rates based on if the address is commercial (false) or residential (true). Default value: false

Example Request

POST /shipments/getrates HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json

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

curl -iX POST https://ssapi.shipstation.com/shipments/getrates \
-H 'Authorization: __YOUR_AUTH_HERE__' \
-H 'Content-Type: application/json' \
-d '{
  "carrierCode": "fedex",
  "serviceCode": null,
  "packageCode": null,
  "fromPostalCode": "78703",
  "toState": "DC",
  "toCountry": "US",
  "toPostalCode": "20500",
  "toCity": "Washington",
  "weight": {
    "value": 3,
    "units": "ounces"
  },
  "dimensions": {
    "units": "inches",
    "length": 7,
    "width": 5,
    "height": 6
  },
  "confirmation": "delivery",
  "residential": false
}'

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")
$headers.Add("Content-Type", "application/json")

$body = "{`n  `"carrierCode`": `"fedex`",`n  `"serviceCode`": null,`n  `"packageCode`": null,`n  `"fromPostalCode`": `"78703`",`n  `"toState`": `"DC`",`n  `"toCountry`": `"US`",`n  `"toPostalCode`": `"20500`",`n  `"toCity`": `"Washington`",`n  `"weight`": {`n    `"value`": 3,`n    `"units`": `"ounces`"`n  },`n  `"dimensions`": {`n    `"units`": `"inches`",`n    `"length`": 7,`n    `"width`": 5,`n    `"height`": 6`n  },`n  `"confirmation`": `"delivery`",`n  `"residential`": false`n}"

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/shipments/getrates' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({"carrierCode":"fedex","serviceCode":null,"packageCode":null,"fromPostalCode":"78703","toState":"DC","toCountry":"US","toPostalCode":"20500","toCity":"Washington","weight":{"value":3,"units":"ounces"},"dimensions":{"units":"inches","length":7,"width":5,"height":6},"confirmation":"delivery","residential":false});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/shipments/getrates", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://ssapi.shipstation.com/shipments/getrates',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"carrierCode":"fedex","serviceCode":null,"packageCode":null,"fromPostalCode":"78703","toState":"DC","toCountry":"US","toPostalCode":"20500","toCity":"Washington","weight":{"value":3,"units":"ounces"},"dimensions":{"units":"inches","length":7,"width":5,"height":6},"confirmation":"delivery","residential":false})

};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/shipments/getrates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}",
  CURLOPT_HTTPHEADER => array(
    "Host: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://ssapi.shipstation.com/shipments/getrates"

payload = "{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}"
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/shipments/getrates")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"
request["Content-Type"] = "application/json"
request.body = "{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://ssapi.shipstation.com/shipments/getrates");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}");
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/shipments/getrates")
  .method("POST", body)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/shipments/getrates"
  method := "POST"

  payload := strings.NewReader("{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}")

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

#import <Foundation/Foundation.h>

dispatch_semaphore_t sema = dispatch_semaphore_create(0);

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://ssapi.shipstation.com/shipments/getrates"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"Host": @"ssapi.shipstation.com",
  @"Authorization": @"__YOUR_AUTH_HERE__",
  @"Content-Type": @"application/json"
};

[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}" dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPBody:postData];

[request setHTTPMethod:@"POST"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
  if (error) {
    NSLog(@"%@", error);
  } else {
    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
    NSError *parseError = nil;
    NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
    NSLog(@"%@",responseDictionary);
    dispatch_semaphore_signal(sema);
  }
}];
[dataTask resume];
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);

import Foundation

var semaphore = DispatchSemaphore (value: 0)

let parameters = "{\n  \"carrierCode\": \"fedex\",\n  \"serviceCode\": null,\n  \"packageCode\": null,\n  \"fromPostalCode\": \"78703\",\n  \"toState\": \"DC\",\n  \"toCountry\": \"US\",\n  \"toPostalCode\": \"20500\",\n  \"toCity\": \"Washington\",\n  \"weight\": {\n    \"value\": 3,\n    \"units\": \"ounces\"\n  },\n  \"dimensions\": {\n    \"units\": \"inches\",\n    \"length\": 7,\n    \"width\": 5,\n    \"height\": 6\n  },\n  \"confirmation\": \"delivery\",\n  \"residential\": false\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://ssapi.shipstation.com/shipments/getrates")!,timeoutInterval: Double.infinity)
request.addValue("ssapi.shipstation.com", forHTTPHeaderField: "Host")
request.addValue("__YOUR_AUTH_HERE__", forHTTPHeaderField: "Authorization")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
  semaphore.signal()
}

task.resume()
semaphore.wait()

Example Response

[
  {
    "serviceName": "FedEx First Overnight®",
    "serviceCode": "fedex_first_overnight",
    "shipmentCost": 87.8,
    "otherCost": 2.63
  },
  {
    "serviceName": "FedEx Priority Overnight®",
    "serviceCode": "fedex_priority_overnight",
    "shipmentCost": 50.23,
    "otherCost": 1.51
  },
  {
    "serviceName": "FedEx Standard Overnight®",
    "serviceCode": "fedex_standard_overnight",
    "shipmentCost": 46.96,
    "otherCost": 1.41
  },
  {
    "serviceName": "FedEx 2Day® A.M.",
    "serviceCode": "fedex_2day_am",
    "shipmentCost": 23.04,
    "otherCost": 0.69
  },
  {
    "serviceName": "FedEx 2Day®",
    "serviceCode": "fedex_2day",
    "shipmentCost": 20.03,
    "otherCost": 0.6
  },
  {
    "serviceName": "FedEx Express Saver®",
    "serviceCode": "fedex_express_saver",
    "shipmentCost": 14.28,
    "otherCost": 0.43
  },
  {
    "serviceName": "FedEx Ground®",
    "serviceCode": "fedex_ground",
    "shipmentCost": 8.25,
    "otherCost": 0.33
  }
]