API Documentation
Everything you need to integrate RateShip into your application.
Everything you need to integrate RateShip into your application.
RateShip gives you one API for all your shipping providers. Connect your Shippo, EasyPost, or ShipEngine accounts and get unified rate results with a single request.
The fastest way to get started is with the official SDK. It handles authentication, request formatting, and typed responses for you.
npm install rateship
Generate an API key from your dashboard. Your key starts with rs_dev_ for development or rs_live_ for production. See Authentication for details.
Add your Shippo, EasyPost, or ShipEngine API keys in the Providers section of your dashboard. RateShip will query all connected providers when you request rates.
Make a single API call to get rates from every connected provider at once. Results are normalized into a consistent format regardless of which provider returned them.
import { RateShip } from "rateship";
const rateship = new RateShip({ apiKey: "rs_dev_your_key_here" });
const { rates, errors } = await rateship.rates.get({
from_address: {
name: "John Smith",
street1: "123 Main St",
city: "New York",
state: "NY",
zip: "10001",
phone: "2125551234",
},
to_address: {
name: "Jane Doe",
street1: "456 Oak Ave",
city: "Los Angeles",
state: "CA",
zip: "90001",
phone: "3105551234",
},
weight: 2.5,
weight_unit: "lbs",
length: 12,
width: 8,
height: 6,
package_count: 1,
});
// rates: unified results from all connected providers
// errors: any provider-specific failuresRateShip gives you one API for all your shipping providers. Connect your Shippo, EasyPost, or ShipEngine accounts and get unified rate results with a single request.
The fastest way to get started is with the official SDK. It handles authentication, request formatting, and typed responses for you.
npm install rateship
Generate an API key from your dashboard. Your key starts with rs_dev_ for development or rs_live_ for production. See Authentication for details.
Add your Shippo, EasyPost, or ShipEngine API keys in the Providers section of your dashboard. RateShip will query all connected providers when you request rates.
Make a single API call to get rates from every connected provider at once. Results are normalized into a consistent format regardless of which provider returned them.
import { RateShip } from "rateship";
const rateship = new RateShip({ apiKey: "rs_dev_your_key_here" });
const { rates, errors } = await rateship.rates.get({
from_address: {
name: "John Smith",
street1: "123 Main St",
city: "New York",
state: "NY",
zip: "10001",
phone: "2125551234",
},
to_address: {
name: "Jane Doe",
street1: "456 Oak Ave",
city: "Los Angeles",
state: "CA",
zip: "90001",
phone: "3105551234",
},
weight: 2.5,
weight_unit: "lbs",
length: 12,
width: 8,
height: 6,
package_count: 1,
});
// rates: unified results from all connected providers
// errors: any provider-specific failures