Skip to main content

Documentation Index

Fetch the complete documentation index at: https://packageretriever.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Package Retriever API

The free shipping API for multi-carrier label creation, rate shopping, and real-time tracking. No subscription required.

Quick start

npm install @packageretriever/sdk
import PackageRetriever from '@packageretriever/sdk';

const pr = new PackageRetriever('pr_test_YOUR_KEY_HERE');

// Validate an address
const address = await pr.addresses.validate({
  name: 'Jane Smith',
  street1: '417 Montgomery St',
  city: 'San Francisco',
  state: 'CA',
  zip: '94104',
  country: 'US'
});

// Get rates
const rates = await pr.rates.get({
  from_address: address,
  to_address: { name: 'Customer', street1: '123 Main St', city: 'Austin', state: 'TX', zip: '78701', country: 'US' },
  parcel: { weight_oz: 16, length: 9, width: 6, height: 2 }
});

// Buy the cheapest label
const label = await pr.labels.create({ rate_id: rates.rates[0].id });
console.log(label.tracking_number); // 9400111899223408065744

Why Package Retriever?

  • Free API access — no $99/month Gold Plan, no subscription tiers
  • BYOA at no surcharge — use your own FedEx/UPS rates without paying extra
  • Published rate limits — no surprises, no undocumented 429s
  • Normalized errors — every error includes a suggestion field telling you what to do next
  • Carbon emissionscarbon_grams on every rate response
  • 5,000 label batches — 10x what ShipStation allows

Switching from ShipStation?

We have a migration guide that maps every ShipStation API endpoint to ours. Your integration takes hours, not days.

Resources