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

# Faire

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

## Pre-Built Tooling

| Category | Details |
| - | - |
| **Authentication** | API Key (X-FAIRE-ACCESS-TOKEN header) |
| **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 **Faire**:

* **Products**
* **Orders**
* **Brands**
* **Inventory**
* **Shipments**
* **Returns**
* **Invoices**
* **Retailers**

***

## Set Up Guide

### Trial Access

| Question | Answer |
| - | - |
| **Offers free trial?** | Yes. Faire is free to join for both brands and retailers. Brands can create an account at [https://www.faire.com/brand](https://www.faire.com/brand) and retailers at [https://www.faire.com/retailer](https://www.faire.com/retailer). |
| **Requires requires paid sandbox** | No paid sandbox required. You can use your Faire account for testing. |
| **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Faire account settings once approved for API access. |

***

### Authentication (API Key)

Faire uses API Key authentication via the X-FAIRE-ACCESS-TOKEN header.

1. Log in to your **Faire account** at [https://www.faire.com](https://www.faire.com).
2. Navigate to **Settings** → **Integrations** → **API Access**.
3. Request API access if you haven't already (approval may be required).
4. Once approved, generate your **API Access Token** from the API settings page.
5. Enter your **API Access Token** into Alloy Automation.

#### API Documentation

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

#### Important Notes

* Faire API access requires approval from Faire's team
* API keys are available for brands selling on Faire
* The API provides access to order management, inventory updates, and product catalog
* Keep your API token secure as it provides full access to your Faire account

***

## Use Cases

### 1) Order synchronization

Automatically sync new orders from Faire retailers into your order management system or ERP, ensuring timely fulfillment and inventory updates.

### 2) Inventory management

Push real-time inventory levels from your warehouse management system to Faire, preventing overselling and keeping your product availability accurate for retailers.

### 3) Product catalog updates

Automatically update product information, pricing, and images on Faire when changes are made in your product information management (PIM) system.

### 4) Shipping and tracking

Sync shipment information and tracking numbers from your fulfillment system to Faire, keeping retailers informed about their order status.

### 5) Returns processing

Automatically process return requests and update inventory levels when retailers initiate returns through the Faire platform.

***

## API Gotchas

* **API access approval:** Faire requires approval for API access. Apply for API access through your account settings and wait for approval before integrating.
* **Rate limiting:** Faire enforces rate limits on API requests. Monitor response headers and implement retry logic with exponential backoff when you receive rate limit errors.
* **Webhook reliability:** Ensure your webhook endpoints are highly available and respond quickly with 2xx status codes. Failed webhooks may result in missed order notifications.
* **Inventory accuracy:** Faire expects accurate inventory levels. Overselling can result in penalties, so ensure your inventory sync is reliable and real-time.
* **Product requirements:** Products on Faire must meet specific quality and content standards. Ensure product data is complete and compliant before publishing.

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.