5 Minute Guide

Quick Start

Create your first shipping label in under 5 minutes. Compare rates from USPS, UPS, and FedEx — all with one API call.

Before You Start

atoship Account

Add Credit

Add funds to your wallet to purchase labels. Pay only for what you use.

Get API Key

Go to Dashboard → Settings → API Keys to generate your key

Get Shipping Rates

Send your package dimensions and addresses to get real-time rates from all carriers. atoship automatically compares USPS, UPS, and FedEx to find the best prices.

JavaScript

// Get shipping rates from multiple carriers
const response = await fetch('https://atoship.com/api/v1/rates', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    from: {
      name: "Your Store",
      street1: "123 Store Street",
      city: "San Francisco",
      state: "CA",
      zip: "94102",
      country: "US"
    },
    to: {
      name: "John Customer",
      street1: "456 Customer Ave",
      city: "Los Angeles",
      state: "CA",
      zip: "90210",
      country: "US"
    },
    parcel: {
      weight: 16,  // ounces
      length: 12,
      width: 8,
      height: 6
    }
  })
});

const rates = await response.json();
// Returns rates from USPS, UPS, FedEx with pricing and delivery estimates

USPS

Priority Mail, Ground Advantage, First Class

UPS

Ground, 2-Day, Next Day Air

FedEx

Ground, Express, Home Delivery

Create a Label

Choose the best rate and create your shipping label. The cost is deducted from your wallet balance.

Create Label

// Create a shipping label
const response = await fetch('https://atoship.com/api/v1/labels', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    rate_id: "rate_abc123",  // From rates response
    label_format: "PDF"      // PDF, PNG, or ZPL
  })
});

const label = await response.json();
console.log('Tracking:', label.tracking_number);
console.log('Label URL:', label.label_url);
// Download and print the label!

Your Label is Ready!

The response includes your tracking number and a URL to download the label PDF. Print it, stick it on your package, and drop it off!

{
  "id": "lbl_abc123",
  "tracking_number": "9400111899223344556677",
  "label_url": "https://labels.atoship.com/lbl_abc123.pdf",
  "carrier": "usps",
  "service": "priority_mail",
  "cost": 8.45
}

What's Next?

Core Concepts

Learn about addresses, rates, labels, tracking, and more

Read Guide

API Reference

Explore all endpoints: rates, labels, tracking, addresses

View API Docs

API Playground

Test API calls interactively in your browser

Try It Out

Client Libraries

Official SDKs for Node.js, Python, PHP, and more

View Libraries