Connect to Etsy API

To connect ERPNext with your Etsy Shop, you need API credentials from Etsy's Developer Portal and then authenticate via OAuth2.

Important — Read Before Proceeding!

Creating an Etsy Personal App requires you to be the authorized owner or designated administrator of both the Etsy shop and the ERPNext instance. Unauthorized creation of API credentials may violate Etsy's API Terms of Use and could result in permanent suspension of your Etsy account.

By proceeding, you acknowledge that: (1) you have the authority to create API credentials for this Etsy shop, (2) you are solely responsible for the secure handling of all API keys and tokens, and (3) the authors and contributors of this software accept no liability for any account suspension, data loss, security breaches, or other damages arising from the use or misuse of this integration. This software is provided "as is" under the terms of the GPL-3.0 license, without warranty of any kind.

I acknowledge the above terms — show setup guide

Creating an Etsy Personal App

Step 1: Access Etsy Developer Portal

1. Go to Etsy Developer Portal
2. Sign in with your Etsy seller account
3. Click Create a New App or Get Started

Step 2: Create a Personal App

1. App Name: Choose a descriptive name (e.g., "my_erpnext")
2. Is this app for development or production?: Select based on your needs
3. What's the URL for your app?: Enter your ERPNext site URL
4. Tell us more: Provide a brief description of how you'll use the API
5. Terms of Use: Review and agree to Etsy's API Terms

After submission, Etsy will approve your app (usually instantly for personal apps).

Step 3: Get Your API Credentials

Once your app is created:

1. Navigate to your app in the Your Apps section
2. Note down your Keystring (this is your CLIENT_ID)
3. Note down your Shared Secret (this is your CLIENT_SECRET)

Keep Credentials Secure

Never share your Shared Secret publicly. Store it securely.

Step 4: Enter API Credentials

In the API Credentials section:

1. CLIENT_ID: Paste your Etsy Keystring
2. CLIENT_SECRET: Paste your Etsy Shared Secret
3. Use localhost: Check this only if running ERPNext locally (self-hosted)

The Redirect URI field is automatically generated. You'll need this in the next step.

Step 5: Save the Document

Click Save to save your Etsy Shop configuration.

Step 6: Set Redirect URI on Etsy Developer Portal

1. Copy the Redirect URI from your Etsy Shop document
2. Go back to your Etsy Personal App
3. Under your app's kebab menu, click Edit callback URLs
4. Paste the Redirect URI from ERPNext
5. Save the changes

Authenticating with Etsy

Step 1: Initiate OAuth Flow

1. In your saved Etsy Shop document, click the Login button
2. You'll be redirected to Etsy's authorization page
3. Review the permissions requested
4. Click Grant Access to authorize the app

Step 2: Complete Authentication

After authorization:

1. You'll be redirected back to ERPNext

An ERPNext login prompt may show up

Log-in with system manager account (Administrator)

1. The Etsy Shop document will automatically update with:
2. Access Token and Refresh Token (stored securely)
3. Etsy User ID and Shop ID
4. Status: Changed from "Disconnected" to "Connected"
5. Expires At: Token expiration datetime

Authentication Complete

Your Etsy Shop is now connected! The app will automatically refresh tokens before they expire.

Next Step

Your shop is connected! Proceed to First Import & Next Steps to import your data.