Magento Etsy Integration Extension – User Manual

1.0 Introduction

Etsy Magento API Integration by KnowBand offers a smart solution to the e-merchants to start selling on the Etsy Marketplace. The store admin can effortlessly sync products to Etsy for the selected categories with the help of this Magento Etsy Integration plugin.

Etsy provides a marketplace specifically for the crafters. The Etsy Magento Integration extension is easy to understand and use. So, the merchants can now find a larger niche audience base with minimal effort by selling their product in the Marketplace.

1.1 Merchant Benefits offered by Magento Etsy integrator by Knowband:

• The Etsy Magento API integrator offers real-time synchronization between the Magento store and the Etsy marketplace.
• The connection between the two stores can be set-up in a few simple steps with the automated approach of the Magento Etsy integration module.
• The Magento store admin can list the products in bulk by creating profiles in the back-end of Etsy Magento API Integration.
• The store admin can easily manage the inventory by making changes in the profiles created in Etsy Magento integrator. The merchants can remove, relist or revise products by simply executing cron jobs in the back-end of Etsy Magento API integrator.
• With the help of Magento Etsy integration extension, the store admin can even add shipping methods for the marketplace customers.
• The Magento Etsy Connector makes it easier for the online merchants to keep track of the product listing.
• The admin can sync the orders received from the marketplace with the orders of the Magento store just at a button click with Etsy Magento integration plugin.
• These orders can be processed from the Magento store itself by raising the invoice. The change in the order status is synced with the marketplace via the automated approach of the Magento Etsy API integration module.
• The Etsy Magento integrator makes it easier for the store admin to track the errors that occurred while product listing.
• Etsy Magento API Integration makes it easier for the store admin to tap a larger audience base and manage the online transaction from a single interface.
• Magento to Etsy synchronization is the easiest way to expand your online business with minimal hassle.

2.0 Installation of Magento Etsy Integration Extension

Follow the following steps for installing Magento Etsy API Integration:

1. Download the extension package of Magento Etsy integration plugin from Knowband.
2. Unzip the package in your root folder of Magento setup via FTP manager (like Filezilla or WinSCP – download here: https://filezilla-project.org/).
3. In Admin Panel go to Etsy Marketplace in the main menu.

4. The Magento Etsy integrator is now ready for use.

This User Manual will guide the users through the Magento Etsy synchronization extension configuration and settings.

2.2 Etsy Marketplace Integration- Seller Account Setup

To start selling on Etsy Marketplace you need to have a seller account on Etsy. In this section, we are listing all the steps to create a seller account on Etsy. Please find them below –

• Go to the link – https://www.etsy.com
• Click on the “Sell on Etsy” button present at the top right corner.
• Click on the “Register” button on the page you are visiting now. Refer to the screenshot given below.

• Fill up the registration form and click on the “Register” button. It would create your seller account and send a verification email to the provided email address.

• Now, it would also redirect you to another page as shown below.

• Now, it is asking to set up your shop preferences. Complete all the highlighted sections – Shop Preferences and Name your shop, Stock your shop, How you will get paid and Set up Billing.

That is it.

2.2.1 Etsy Marketplace Integration- Setup an App

To start communication between Magento Store and Etsy Seller Account, you need to create an App on Etsy Marketplace. Following are the steps to create an App on Etsy –

• Go to the link – https://www.etsy.com/developers/register
  It would open a page where a form will be shown with few input fields as shown below.

• Fill up the form and click on “Read Terms and Create App”. Please make sure that you left the “Inventory Management Compatibility” checkbox is checked.
• It would ask to accept “terms and conditions”. Accept and click on the “Create App” button.
• It would register your App on Etsy Marketplace and provide API details as shown below.

Note: “The term ‘Etsy’ is a trademark of Etsy, Inc. This application uses the Etsy API but is not endorsed or certified by Etsy, Inc.”

3.0 Admin Interface

Admin Panel Settings of Etsy Magento synchronization extension contains the 8 tabs for settings.

1. General Settings
2. Shipping
3. Order Settings
4. Profile Management
5. Product Listing
6. Existing Products Mapping
7. Order Listing
8. Synchronization
9. Audit Log

3.1 General Settings

Magento Etsy API integrator allows the store admin to integrate their store in a few simple steps. General Settings tab includes the details of Etsy Marketplace API like API Key, Host, etc. Etsy API helps to connect the Magento store with the Etsy marketplace. The description of each input field is mentioned below:

1. Enabled

Admin gets the option to Enable/Disable the module by toggling the button. If enabled, the module and all its settings will be working on the store.

2. Etsy API Key

Enter the Etsy API Key which will authenticate the connection being established between the Magento store and Etsy Marketplace.

3. Etsy API Secret

Enter Etsy API Secret Key here. It is mandatory for authenticating the integration between the store and Etsy Marketplace.

4. Etsy Default Language

Select the default language to be used.

5. Languages to Sync

Magento Etsy connector offers multi-lingual support. Choose the language used for synchronizing the product. The selected language should be anything other than the default language.

6.Register Etsy Customers
Magento Etsy Integration Module allows the admin to register the list of customers who have placed their orders on the Etsy store.

7. Send Email to Etsy Customers
Enable this feature to send emails to the registered customers.

8.Email Subject( When Customer is registered on the store)
The subject of the emails sent to the registered customer can be customized from the backend of Magento Etsy Connector.

9.Email Template (When Customer is registered on the store)
Magento Etsy Integration Module offers admin the choice to customize the email templates as per his choice.

Click on the ‘Save Configuration’. ‘Connect’ button will appear when the changes are saved. Click on the “Connect” button to connect with the Etsy Marketplace. It would redirect admin to Etsy Marketplace to allow the App Access to the store. Click on the “Allow Access” button as shown below. The connection between the store and Etsy Marketplace will be established.

It would also redirect admin back to the same page of “General Settings” and show the “Disconnect” button instead of “Connect” as the connection has now been set up with Etsy Marketplace.

Note: Once the connection is set-up, you need to execute the Country/Region cron to sync the country list in the database. (See section 3.7.)

3.2 Shipping

The admin can manage the shipping options in the Shipping tab of the Etsy Magento integration plugin. In this section, the admin can create Shipping Templates that contain the various shipping details as per the need of the system.

3.2.1 How to add Shipping Templates?

Follow the steps mentioned below to add Shipping Template:

To create new templates, click on ‘Add New’ as shown below:

You’ll be redirected to the template creation page. Fill up the following input fields of form –

Shipping Template Title: Enter the Shipping Template Title here.

Origin Country: Choose a country from the list as an origin country of Shipment.

Primary Cost: Provide the primary cost of the shipment. You can set it only once.

Secondary Cost: Provide the shipping cost for each additional item. You can set it only once.

Minimum Processing Days: Provide the minimum number of days for processing the shipment.

Maximum Processing Days: Enter the maximum processing days for processing the shipment.

3.2.2 How to Edit/Delete the existing Shipping Templates?

The Shipping templates (if any) will be listed in the Shipping Template tab of the Etsy Magento integrator. Click on the “Edit or Delete” button as shown in the image:

3.2.3 How to add Shipping Template Entries Template?

Each Shipping Template can have multiple shipping entries to define shipping destinations and their respective costs according to the destinations. Etsy Magento integration extension allows you to set up only one shipping template entry for each destination country.

The shipping entries can be viewed by clicking on ‘View Shipping Entries’.

This will redirect you to the shipping entries page of the Magento Etsy integration plugin. The admin can view the entries here.

Click on the Add New Entries button to create new entries.

This will redirect you to the entry creation page.

While the Origin and Shipping Template Title will remain the same, the Destination type, Destination country, primary cost, and secondary shipping cost can be entered here.

The existing list can be viewed with the help of Magento Etsy integrator as shown below. To Edit/Delete the existing entries, click on ‘Edit’ and ‘Delete’ action respectively.

Note: Execute the Shipping Template cron from the back-end of the Magento Etsy API Integration to sync the entire shipping templates in the Etsy Marketplace. (See Section 3.7.)

3.3 Order Settings

Order Settings tab of Magento Etsy integration module helps to map store order statuses with Etsy Marketplace order statuses. This will be used for capturing order details from Etsy Marketplace. For mapping the orders from the Etsy Marketplace to the Magento store, you need to execute the Order cron in the Synchronization tab of Magento Etsy integrator. (See section 3.7.)

The various fields are discussed below:

Order Default State: Choose an order default status.

Order Paid State: Choose an ordered state for the paid orders placed on the Etsy marketplace.

Order Shipped Status: Choose an ordered state for the shipped orders on the Etsy marketplace.

Note –

The default status is the first status of the order when it is placed on the store.

Paid status means that payment for the order has been made and accepted.

Shipped status means that ordered items have been shipped.

3.4 Profile Management

The profile-based listing of Magento Etsy integration plugin makes it easier for the online merchants to manage the inventory. Profile Management tab of the Etsy Magento Integration module provides options to create N number of profiles for product listing. In this section, the admin can map attributes of Magento store products with the attributes of Etsy Marketplace. The admin can even map the categories of the Magento store with the categories of Etsy Marketplace. Magento Etsy integration extension offers many-to-one category mapping.

Once you click on ‘Add New’, you’ll be redirected to the profile creation page of Etsy Magento integrator. The various fields are discussed below:

Profile Title: Enter the profile name here.

Etsy Category: Choose an Etsy Marketplace Category to list the attributes.

Attribute Mapping: Map the selected Etsy Marketplace attributes to the store’s attributes. Select the ‘Size’, ‘Primary color’. This will help the list the products with variations.

Store Categories: Select the category of the store that you want to map with the selected category of the Etsy Marketplace. At a time multiple store categories can be selected.

Shipping Template: Choose a Shipping Template from the drop-down list. The customer can avail of the selected shipping options.

In case, if Shipping Templates are not being displayed, Run Synchronization -> Sync Shipping Templates

Etsy Currency: This currency should be the same as the currency of your Etsy Admin panel, you can check the Etsy currency in Finances -> Payment Settings -> Currency.

Customized Product Title: Customize the product title by using the following place-holders. Place-holders like {sample} will be replaced by dynamic content at the time of execution.

• {id_product} for Product ID
• {product_title} for Product title
• {country_of_manufacture} for Country of Manufacturer
• {sku} for Product SKU
• {weight} for Product Weight
• {short_description} for Product Short Description
• {price} for Product Price

Tags: The Etsy search shows results if the word or phrase is available in the product title or tags. The store admin can add the tags for the entire category at the time of creating the profile. The Etsy Magento Integrator module allows the store admin to add the maximum 13 tags.

Materials: The Etsy Magento Integration module allows the store admin to sync the Materials used in the product. For example Ingredients, components, etc.

Price Type: The Etsy Magento Integration Module allows the store admin to list the product on Etsy Marketplace at a different price than the Magento store price. Admin can select the option to sync the Actual or Special rice from the Magento store. Admin also has the option to increase or decrease the product price based on the Fixed or Percentage basis.

Change price: The store admin has access to change the price of goods at the Etsy store. Enable the Change price feature to increase or decrease the price of products listed at Etsy in comparison to their actual price.

Type: Select whether you want to increase or decrease the product price.

Amount: Enter the amount value in this field.

Sync Property: Select the properties to sync with the Etsy Marketplace. This will work while updating the product and its variations

Enable to enter minimum quantity: If enabled, the quantity of the items will be restricted to the minimum amount filled the following text box.

Enable to enter maximum quantity: If enabled, the quantity of the items will be restricted to the maximum amount filled the following text box.

Is the product customizable?: Enable if the product is customizable.

Who Made: Specify who made the specific product. Select an option from the drop-down list.

When Made: Specify when this product was made.

Is Supply?: Specify if the product is the product is supply product or not.

Recipient: Select the Recipient of the product

Occasion: Specify the Occasion (if any) for which the product is intended.

3.5 Product Listing

This section of the Magento Etsy integration plugin shows the list of all the products listed on Etsy Marketplace with their statuses. To sync the product in the Etsy Marketplace, execute the Product Cron in the Synchronization tab of the Etsy Magento Integration module. (See section 3.7.)

One the product is listed and synchronized, the status of the product variations will appear pending. To list them, the admin will be required to execute the ‘Product Variation’ cron in the Synchronization tab of the Etsy Magento integration plugin. Once this is done, even those products will get listed.

Product Listing Renewal

This option offered by Magento Etsy integrator allows admin to renew product in case listing has expired on Etsy Marketplace. To renew the product, the admin can click on the “Renew” action corresponding to each product.

After setting up a product for renewal, action “Renew” will be replaced with “Halt” action. This action is used to stop product renewal in case needed.

Auto Renew

Admin can also set products at the “Auto Renew” option. This option will automatically renew a particular product.

Product Listing Deletion

This option of Etsy Magento integrator allows admin to delete product listing from Etsy Marketplace. Click on “Delete” action given corresponding to each product listing. After setting up a product for deletion, the action “Delete” will be replaced with “Relist” action.

View Error

The admin can view the error that occurred in listing the product. For this, click on ‘View Error’ action.

3.6 Existing Products Mapping

Under this tab, the admin would be able to view the list of existing mapped products on Etsy Marketplace. Admin can search a particular product by setting filters accordingly.

3.7 Order Listing

This tab of Magento Etsy connector shows the list of orders placed on Etsy Marketplace for the products of your eCommerce store listed on Etsy as shown in the screenshot below –

To sync the orders received from the Etsy Marketplace into your Magento store, you need to execute the Order Syncing cron in the Synchronization tab of Magento Etsy connector. (See section 3.7)

To check the order, click on ‘View’.

The admin gets to see the following details of each order.

It offers basic information like order date, status, billing and shipping address, payment information, gift options, item ordered, comments history.

The default order view page is shown below:

1. Invoice: The admin can generate the invoice for the orders received from here. This will initiate the processing of the order. Execute the Update Order Status on Etsy cron and the status of that order will be updated in the Etsy Marketplace.
2. Credit Memos: Change the status of the credit here.
3. Shipments: The admin can update the shipment details, that is, the name of the shipment, date and the quantity of shipment.

3.8 Synchronization

The Magento Etsy integration module offers several synchronization options. This tab of the Etsy Magento integration extension synchronizes all the settings and options defined in the other tabs. The synchronization between Magento Store and Etsy Marketplace can be done by clicking the ‘Synchronize’ button.

The various crons offered by Magento Etsy Integration extension to synchronize content between Store and Etsy Marketplace are shown below –

3.8.1 How to sync Countries/Region on Etsy Marketplace?

Following are the steps to synchronize Countries/Region on Etsy Marketplace –

• Go to the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Countries/Region” button shown below.

It would perform following actions –

• The cron will get all the countries with their country ID and ISO code and save it into the database.
• Once the cron is executed, the countries and regions in the database will be visible in the Shipping Template tab as well.

3.8.2  How to sync Shipping Template on Etsy Marketplace?

Following are the steps to synchronize Shipping Templates on Etsy Marketplace –

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Shipping Template” button shown below.

It would perform following actions –

• It will add new shipping templates along with their Entries on Etsy.
• It will update the modifications made in the Shipping Templates and their entries on Etsy
• It will delete the shipping templates and their entries that were deleted from the store on Etsy.

3.8.3  How to sync Products on Etsy Marketplace?

Following are the steps to synchronize Products on Etsy Marketplace –

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Products” button shown below.

It would perform following actions –

• The cron will update the product list based on the profiles created into the system.
• It will add products on the Etsy Marketplace with the respective product details (e.g. Price, Quantity, Image, etc.).
• It will update the products on Etsy marketplace which are already listed
• It will renew the expired products on Etsy Marketplace for the items in which ‘Renewal’ is enabled.
• It will remove the products from Etsy Marketplace which are marked deleted on Store.
• It updates the Listing Status of each product listed on Etsy Marketplace.

3.8.4  How to sync Products Variation on Etsy Marketplace?

Following are the steps to synchronize Products Variation on Etsy Marketplace –

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Products Variation” button shown below.

It would perform following actions –

The cron execution will add Products Variations on Etsy Marketplace

It will update Products Variations which are already listed on Etsy Marketplace

It will remove the Products Variations on Etsy Marketplace that are marked as deleted on the Store.

3.8.5 How to sync  Etsy Non-mapped products?

Following are the steps to synchronize Etsy Non-Mapped products with your store–

• Go to the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Etsy Not-Mapped products” button shown below.

It would perform the following actions:

• In case, if any product is not mapped with the store then, the same will be synchronized in the Etsy marketplace.

3.8.6  How to sync Order Listing from Etsy Marketplace?

Following are the steps to synchronize Orders from Etsy Marketplace –

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Orders” button shown below.

It would perform following actions –

Once this cron is executed, it will get the Orders and Transaction details from the Etsy Marketplace.

It creates Shipping Carrier options into the store as per the details of the order coming from Etsy Marketplace

It creates Orders into the Magento store as per the details coming from the Etsy Marketplace and sets the order status as per the configuration settings updated in the “Order Settings” tab of this Magento Etsy Marketplace module.

3.8.7  How to sync Order Status on Etsy Marketplace?

Following are the steps to synchronize Orders Statusto Etsy Marketplace:

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Order Status” button shown below.

It would perform following actions –

• The cron checks if there is any status update recorded by the module for any Etsy Order. The updates are then synchronized accordingly.
• It updates the Status of Orders as per the configuration settings modification in the “Order Settings” tab of the admin interface.

3.8.8  How to sync Language on Etsy Marketplace?

Following are the steps to synchronize Language to Etsy Marketplace:

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Language” button shown below.

It would perform the following actions:

In case there are any product or category details in different languages, then, the same will be synchronized in the Etsy marketplace.

3.8.9 How to sync  Products Inventory/Price?

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Products Inventory/Price Synchronization” button shown below.

It would perform the following actions:

In case of any change in the inventory/price of the Magento store product then the admin needs to sync the updated price/inventory of the product to the Etsy marketplace. To make the entire process hassle-free the Products Inventory/Price Synchronization cron update the product price at the Etsy marketplace.

3.8.10 How to sync  Product  Images?

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Sync Product Images” button shown below.

It would perform the following actions:

• Instead of updating the Products images individually on Etsy Marketplace, admin can update the same by running the Sync Product Images.

3.8.11 Full Magento Update Synchronization

• Goto the Etsy Marketplace ->Synchronization tab (Main Menu)
• Click on the “Products Inventory/Price Synchronization” button shown below.

It would perform the following actions:

Instead of running multiple crons to update the Products/Price/Inventory/Translation/Variation on Etsy admin can update the same by running the Full Magento Update on Etsy cron.

Note:

Once the synchronization is completed successfully, then, a message will be display – “Synchronization completed” else “Synchronization failed” will be flashed.

3.9 Audit Log

The Audit Log section of Magento Etsy integration plugin contains the entire list of the job that is running. The status of the same can be viewed here. The errors (if any) occurred while executing the jobs can be checked here.

Click Here to get Etsy Magento Integration Plugin

Click Here to view Admin Demo of Magento Etsy Integrator

Watch Plugin Video of Magento Etsy integration extension