API Reference

The Parcelers API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL: https://api.parcelers.com/v1

Authentication

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

// Authenticated Request

curl https://api.parcelers.com/v1/shipments \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:

Create a Shipment

POST /v1/shipments

This endpoint creates a new shipment, purchases the label, and returns the tracking information immediately.

Parameters

to_address object
The destination address.
from_address object
The origin address.
parcels array
List of parcels including weight and dimensions.

// Request
{
  "to_address": {
    "name": "Dr. Steve Brule",
    "street1": "179 N Harbor Dr",
    "city": "Redondo Beach",
    "state": "CA",
    "zip": "90277",
    "country": "US"
  },
  "parcels": [{
    "length": 10,
    "width": 8,
    "height": 4,
    "weight": 15.4
  }]
}

Get Rates

POST /v1/rates

Retrieve real-time quotes for a shipment without buying a label. Useful for showing shipping costs at checkout.

// Response
{
  "rates": [
    {
      "carrier": "DHL",
      "service": "Express",
      "rate": "24.50",
      "currency": "USD",
      "days": 2
    },
    {
      "carrier": "USPS",
      "service": "Priority",
      "rate": "12.00",
      "currency": "USD",
      "days": 5
    }
  ]
}