> ## 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.

# EasyShip

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

## Pre-Built Tooling

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

***

## Objects Supported

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

* **Account**
* **Addresses**
* **Analytics**
* **Auto Recharge**
* **Batches**
* **Boxes**
* **Categories**
* **Companies**
* **Courier Accounts**
* **Rates**
* **Shipments**
* **Tracking**
* **Warehouses**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                                          |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | Yes. Easyship offers a free account with pay-as-you-go pricing. Sign up at [https://www.easyship.com](https://www.easyship.com) to get started. |
| **Requires requires paid sandbox**                 | No paid sandbox required. You can use the free account with test mode for development.                                                          |
| **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Easyship account settings.                                                               |

***

### Authentication (Bearer Token)

Easyship uses Bearer token authentication with an API key.

1. Log in to your **Easyship account** at [https://www.easyship.com](https://www.easyship.com).
2. Navigate to **Connect** → **API Access** in the left sidebar.
3. Click **Generate API Key** or copy your existing API key.
4. Enter your **API Key** as a Bearer token in Alloy Automation.

#### API Documentation

For detailed API documentation, visit: [https://developers.easyship.com/](https://developers.easyship.com/)

#### Important Notes

* Easyship provides both production and sandbox API keys for testing
* The API key provides full access to your account, so keep it secure
* Easyship uses version-specific API endpoints (e.g., v2024-09)

***

## Use Cases

### 1) Multi-carrier shipping rates

Fetch real-time shipping rates from multiple carriers through a single API integration, enabling customers to compare options and select their preferred shipping method at checkout.

### 2) Label generation and fulfillment

Automatically create shipments and generate shipping labels when orders are placed in your ecommerce platform, streamlining the order fulfillment process.

### 3) International shipping automation

Calculate duties, taxes, and landed costs for international shipments, and generate compliant customs documentation automatically for cross-border orders.

### 4) Tracking and notifications

Sync tracking numbers and shipment status updates from Easyship to your order management system, enabling automated customer notifications and support inquiries.

### 5) Warehouse and inventory management

Manage multiple warehouses, allocate inventory across locations, and optimize shipping costs by automatically selecting the nearest fulfillment center for each order.

***

## API Gotchas

* **API versioning:** Easyship uses date-based API versions (e.g., v2024-09). Make sure to use the correct version in your API requests and stay updated on version deprecations.
* **Rate limiting:** Easyship enforces rate limits on API requests. Monitor response headers for rate limit information and implement appropriate retry logic.
* **Currency and units:** Be consistent with currency codes (ISO 4217) and measurement units (metric vs imperial) across your integration to avoid errors in rate calculations.
* **Address validation:** Easyship performs address validation during shipment creation. Invalid addresses will result in errors, so validate addresses before submitting shipment requests.
* **Courier account setup:** Some shipping options require you to connect your own courier accounts in Easyship. Make sure the necessary courier accounts are set up before attempting to create shipments.

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