> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Easypost

> Integration details and setup guide for the Easypost connector in Alloy Automation.

## Pre-Built Tooling

| Category                            | Details                             |
| ----------------------------------- | ----------------------------------- |
| **Authentication**                  | HTTP Basic Authentication (API Key) |
| **Two-Way Sync**                    | Yes                                 |
| **Events Supported**                | Yes (Webhooks)                      |
| **Realtime**                        | Yes                                 |
| **Supports Rate Limiting**          | Yes                                 |
| **Authentication Scopes Supported** | N/A (API Key based authentication)  |

***

## Objects Supported

Alloy Automation supports syncing the following objects from **Easypost**:

* **Addresses**
* **Parcels**
* **Shipments**
* **Rates**
* **Tracking**
* **Batches**
* **Insurance**
* **Customs Info**
* **Carriers**
* **Webhooks**
* **Events**
* **Pickups**
* **Refunds**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                                                                                 |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | Yes. EasyPost offers a free test mode with no credit card required. Sign up at [https://www.easypost.com](https://www.easypost.com) to get started. Production usage is pay-as-you-go. |
| **Requires requires paid sandbox**                 | No paid sandbox required. Test mode is completely free for development and testing.                                                                                                    |
| **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your EasyPost account dashboard.                                                                                                     |

***

### Authentication (HTTP Basic Authentication)

EasyPost uses HTTP Basic Authentication with your API Key.

1. Log in to your **EasyPost account** at [https://www.easypost.com](https://www.easypost.com).
2. Navigate to **API Keys** in your account dashboard.
3. You'll see both **Test** and **Production** API keys. Copy the appropriate key for your environment.
4. Enter **your API key** as the username in Alloy Automation (password field can be left empty or use the API key again).

#### API Documentation

For detailed API documentation, visit: [https://www.easypost.com/docs/api](https://www.easypost.com/docs/api)

#### Important Notes

* EasyPost provides separate API keys for test and production environments
* Test mode uses test carrier credentials and won't create real shipments
* Production API keys require account verification and funding
* API keys authenticate using HTTP Basic Auth with the key as the username and blank password

***

## Use Cases

### 1) Multi-carrier rate shopping

Compare shipping rates across 100+ carriers in real-time to offer customers the best price and delivery options at checkout without managing individual carrier integrations.

### 2) Label printing automation

Automatically purchase shipping labels when orders are placed, eliminating manual label creation and streamlining your fulfillment workflow.

### 3) Package tracking

Retrieve real-time tracking information from multiple carriers through a unified API, enabling automated customer notifications and support ticket updates.

### 4) Address verification

Validate and standardize shipping addresses before creating shipments to reduce delivery failures and return-to-sender issues.

### 5) International shipping compliance

Automatically generate customs forms and calculate duties and taxes for international shipments, ensuring compliance with cross-border shipping regulations.

***

## API Gotchas

* **API key security:** EasyPost API keys provide full account access. Never expose them in client-side code or public repositories. Use separate test and production keys.
* **Test vs production mode:** Test API keys use test carrier accounts that don't create real shipments. Make sure to switch to production keys when going live.
* **Address verification timing:** Address verification is a separate API call that should be done before creating shipments. Unverified addresses may result in delivery failures.
* **Rate caching:** Shipping rates can change frequently. Don't cache rates for extended periods—fetch fresh rates at checkout to ensure accurate pricing.
* **Webhook signatures:** EasyPost webhooks include signatures for security. Always verify webhook signatures to ensure requests are coming from EasyPost.

> For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**.
