API Documentation

Everything you need to integrate RateShip into your application.

GET/api/v1/labels

Label History

List your purchased labels with optional filtering.

Query Parameters

Param	Type	Default	Description
page	number	1	Page number
page_size	number	10	Results per page (max 50)
provider	string	-	Filter: "shippo", "easypost", "shipengine"
date_from	string	-	Filter: created on/after (YYYY-MM-DD)
date_to	string	-	Filter: created on/before (YYYY-MM-DD)

import { RateShip } from "rateship";

const rateship = new RateShip({ apiKey: "rs_dev_your_key_here" });

const { items, page, total } = await rateship.labels.list({
  page: 1,
  page_size: 10,
});

Response

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "...",
        "provider": "shippo",
        "carrier": "USPS",
        "service": "Ground Advantage",
        "price_cents": 965,
        "tracking_number": "9400111899223411922349",
        "label_url": "https://cdn.goshippo.com/labels/...",
        "created_at": "2025-03-14T10:00:00Z"
      }
    ],
    "page": 1,
    "page_size": 10,
    "total": 42,
    "total_pages": 5
  }
}

GET/api/v1/labels

Label History

List your purchased labels with optional filtering.

Query Parameters

Param	Type	Default	Description
page	number	1	Page number
page_size	number	10	Results per page (max 50)
provider	string	-	Filter: "shippo", "easypost", "shipengine"
date_from	string	-	Filter: created on/after (YYYY-MM-DD)
date_to	string	-	Filter: created on/before (YYYY-MM-DD)

import { RateShip } from "rateship";

const rateship = new RateShip({ apiKey: "rs_dev_your_key_here" });

const { items, page, total } = await rateship.labels.list({
  page: 1,
  page_size: 10,
});

Response

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "...",
        "provider": "shippo",
        "carrier": "USPS",
        "service": "Ground Advantage",
        "price_cents": 965,
        "tracking_number": "9400111899223411922349",
        "label_url": "https://cdn.goshippo.com/labels/...",
        "created_at": "2025-03-14T10:00:00Z"
      }
    ],
    "page": 1,
    "page_size": 10,
    "total": 42,
    "total_pages": 5
  }
}