Activate & Connect

After deploying the extension, this guide walks you through registering an application on the Etsy Developers Portal, enabling the module in Magento's System Configuration, and establishing the OAuth connection.

Step 1: Register an Etsy Developer Application

To connect Magento with Etsy's API v3, you need an API key and shared secret generated from the Etsy Developers console.

1. Log in to the Etsy Developers Portal

1. Visit https://www.etsy.com/developers and log in with your primary Etsy seller account.
2. Click Your Apps in the top navigation or navigate to https://www.etsy.com/developers/your-apps.
3. Click the Create a New App button.

2. Fill in Application Details

Complete the registration form with the following parameters:

• Application Name: Enter an identifiable name, such as YourStore Marketplace Etsy Connector.
• Description: Briefly describe that the application synchronizes catalog listings, stock levels, and customer orders with your Magento 2 multi-vendor store.
• Who will be the users of this application?: Select Just myself and collaborators or Public, depending on your organization structure.
• Is your application commercial?: Select Yes.
• Will your app do any of the following?: Check options relevant to your workflow (Upload/edit listings, Read sales data, Manage inventory).
• Callback URL / Redirect URI: Enter your exact Magento store callback URLs. Etsy allows specifying multiple callback URLs (one per line):
  • For Admin Panel Accounts:

    https://<your-store-domain>/<admin_frontname>/mpetsymagentoconnect/oauth/index/id/<account_id>
    
    (Example for default admin path and account ID 1: https://<your-store-domain>/admin/mpetsymagentoconnect/oauth/index/id/1)
  • For Marketplace Sellers (Frontend):

    https://<your-store-domain>/mpetsymagentoconnect/oauth/index/
    

3. Copy Your API Credentials

Once the application is created, navigate to the app details screen and copy:

1. Keystring (Client ID): Used as the Oauth Consumer Key in Magento.
2. Shared Secret: Used as the Oauth Consumer Secret in Magento.

Step 2: License Key Verification (Module License Tracker)

Webkul extensions require license authentication via the Webkul Module License Tracker (integrated via Webkul_Base). This tracks authorized module installations, unlocks full functional capabilities, and validates your store for official support and upgrades.

Verification Steps:

1. Log in to your Magento Admin Panel.
2. Navigate to Stores → Configuration → Webkul → Module License.
3. Under the Licensed Modules table:
   • Locate the row for Marketplace Etsy Magento Connect (as well as Marketplace Multi Vendor).
   • The initial status will display as UNVERIFIED.
4. Enter the valid License Key corresponding to your purchase (retrievable from your Webkul Store account under your order downloads).
5. Click the orange Save & Verify button in that row.
6. The system connects to Webkul's license validation server. Once verified, the status indicator changes from UNVERIFIED to VERIFIED.

Step 3: Enable the Module in Magento Admin

1. In your Magento Admin Panel, navigate to Stores → Configuration → Webkul → Marketplace Etsy Magento Connect.
2. Under the General Settings section:
   • Set Enable Marketplace Etsy Connector to Yes.
3. Configure the Global Etsy App mode:
   • Use Etsy Global App Details For All Etsy Account:
     • Yes (Recommended): All marketplace sellers authenticate against your store's single Etsy Developer App. Sellers only need their shop name without needing developer accounts.
     • No: Each seller must create their own Etsy Developer App and input their individual Keystring and Secret into their seller panel.
   • If set to Yes:
     • Enter your copied Oauth Consumer Key (Keystring).
     • Enter your copied Oauth Consumer Secret (Shared Secret).
4. Click Save Config in the top right corner.

5. Flush configuration cache:

   php bin/magento cache:clean config
   

Step 4: Verify Admin Menu & Permissions

Once enabled, confirm the administrative menus are accessible:

1. Open the Magento Admin sidebar and navigate to Marketplace → Marketplace Etsy Magento Connect:
   • Etsy Accounts Manager: View, add, edit, and authenticate Etsy seller shops.
   • Map Category: Map Etsy taxonomy branches to Magento store categories.
   • Configuration: Direct shortcut to the System Configuration section.
2. For restricted administrative user roles, verify permissions in System → User Roles → [Role] → Role Resources:
   • Ensure the resource Marketplace Etsy Magento Connect (Webkul_MpEtsyMagentoConnect::manager) and its sub-resources are checked.

Step 5: Verify Seller Dashboard Navigation

Log in to the storefront as an approved marketplace vendor and visit the customer account dashboard:

1. Under the Marketplace navigation menu on the left, locate the Etsy Connector section:
   • Etsy Account Manager (mpetsymagentoconnect/account/index)
   • Etsy Settings (mpetsymagentoconnect/settings/index)
   • Map Category (mpetsymagentoconnect/category/index)
   • Import Product From Etsy (mpetsymagentoconnect/productimport/index)
   • Export Product To Etsy (mpetsymagentoconnect/productexport/index)
   • Etsy Order History (mpetsymagentoconnect/importorder/etsyorderhistory)
2. If the module is disabled in System Configuration (status = 0), these menu items automatically hide from the seller navigation.