Opencart Etsy Marketplace Integration – User Manual

Introduction

Marketplaces have played a vital role in the growth of the e-commerce. Amazon and eBay are some of the well-known platforms, but in recent years a number of new marketplaces have marked their presence in the eCommerce ecosystem. Etsy is one of the most popular marketplaces for handmade goods and vintage items. Etsy allows the people from around the globe to buy and sell unique goods. This platform invites the sellers to showcase their creativity to the new audience, thus, helping them to reach out to the potential customers globally. Etsy is a great place to extend the reach of your business. The process of starting the business on Etsy marketplace is quite easy. Please click on the link below to know more about the rules and regulations of trading: https://www.etsy.com/in-en/sell

KnowBand, an Commerce plugin and marketplace integration development company offers the OpenCart Etsy integration module. The plugin allows the seller to synchronize their OpenCart store with the Etsy marketplace in a few simple steps. We do understand that being ready to start selling on Etsy marketplace, it is also important for the store owner to analyze their business method and process so that they can be able to keep up with the new challenges. After starting to sell on multi channel sellers have to keep the proper track of their inventory status, products listings, shipping methods, delivery time and customer support. In order to overcome all the major challenges of selling on a marketplace, KnowBand has developed the OpenCart Etsy Integration module. With the help of the Etsy OpenCart Integration extension, OpenCart store owners can effectively manage the inventory, orders and shipping for the Etsy shop orders from OpenCart store admin. OpenCart Etsy marketplace integration module offers following advantages to the sellers:

  • Easy installation and user friendly interface: The user-friendly interface of the OpenCartEtsy Integration plugin offers an effortless interfaceto list the products to the Etsy marketplace.
  • Bulk uploading of the products: OpenCartEtsy integration module allows the sellers to upload products in bulk. Sellers can create profile to upload the entire category of the OpenCartstore to the Etsy marketplace.
  • Category and product attribute mapping: Sellers can easily map the product attributes and category of the OpenCartstore products with the Etsy store attributes and category.
  • Shipping templates: Create shipping templates from the OpenCartstore admin panel and sync these templates to the Etsyshop.
  • Order Management: Manage and keep track of Etsy shop orders from the OpenCartstore admin panel.
  • Order status: Admin can update the order status of the Etsy marketplace orders from OpenCartstore admin panel through cron job.
  • Inventory management: Manage inventory for the Etsy store products from the OpenCartadmin panel. After making any changes in the product inventory or attributes in the OpenCartstore, theadmin can easily synchronize the changes to the Etsy marketplace.
  • Secondary language: Admin can select secondary language for the store and easily synchronize it with the Etsy marketplace shop through cron job.

2.0 Installation

After purchasing the module, you will get following files as listed below:

1. zip (contains source code of the module)

2. User Manual

Follow the following steps to install the extension:

  1. Unzip the zip file. It would contain files and folders as shown below –

2. Copy all the files and folders of unzipped folder into the root folder of the website.

3. Now module is ready to be installed on your store and you can find that in Store Admin -> Modules and Services. It would shown as below –

3.0 System Setup

Before proceeding ahead, it is important to know the correct flow of actions to setup this system as there are several things which are dependent of other things.If we do not take care of them then it would become difficult to process smoothly or it may be error prone.

  • Seller account setup: This section will help you to setup the shop on Etsy marketplace and in the next steps you will learn about the Etsy API key. Etsy API key and API Secret is required to integrate the Opencart and Etsy marketplace.
  • Admin Interface: This section will help you to understand the complete working of the Etsy Opencart Integration plugin.

4.0 Etsy Marketplace – 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 –

1. Goto the link – https://www.etsy.com/in-en/sell

2. Click on the “Open your Etsy Shop” button on the page you are visiting now by following link given in first step above or you can refer the screenshot given below.

3. It would open a Pop-up as shown below. Click on the “Register” tab.

4. After filling up the registration form, click on “Register” button. It would create your seller account and send a verification email to the provided email address. It would also redirect you to another page as shown below.

5. Now, it is asking to setup 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.

5.0 Etsy Marketplace – Setup an App

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

1. Go to the link – https://www.etsy.com/developers/register

2. It would open a page where a form will be shown with few input fields as shown below.

um-etsy

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

4. It would ask to accept “terms and conditions”. Accept and click on “Create App” button.

5. It would register your App on Etsy Marketplace and provide API details as shown below.

6.0 Admin Interface

OpenCart Etsy Integration plugin is easy to configure. The configuration settings can be managed via the admin interface. After installation, store admin can find the “Etsy” module in the Extension List under the “Extensions” tab.

The Etsy integration extension will be displayed as shown below:

On clicking the Edit button next to the Etsy module, it will redirect to the admin interface. Here admin can see all the options to configure the Etsy module:

Etsy Marketplace extension offers following options –

  1. General Settings
  2. Profile Management
  3. Shipping Templates
  4. Shipping Templates Entries
  5. Products Listing
  6. Orders Setting
  7. Order Listing
  8. Synchronization
  9. Audit Log

Each tab is explained below.

6.1 General Settings

You can find the screenshot of “General Settings” page below –

General Settings tab is there for capturing details of Etsy Marketplace API’s like API Key, Host etc. This helps the admin to connect the OpenCart store with the Etsy marketplace. Please find the description of each input field below –

1. Enable/Disable

Admin can Enable/Disable OpenCart Etsy integration module by using this option. If enabled, then only this module and all its settings will be working otherwise there will be no impact of this module on the store.

2. Etsy API Key

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

3. Etsy API Secret

Admin needs to enter Etsy API Secret mandatory for authentication between OpenCartstore and Etsy Marketplace.

4. Etsy API Host

Thetext box contains Etsy API Host URL that is mandatory to send API requests. This is a read-only field.

5. Etsy API Version

The text box contains Etsy API Version number which is mandatory for API requests. This is a read-only field.

After providing these details, click on “Connect” button. It would redirect the admin to the Etsy Marketplace to allow the App Access for the store. Click on the “Allow Access” button as shown below and it would establish the connection between store and Etsy Marketplace.

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

6.2 Profile Management

Profile Management tab provides options to create the profile for products listing. In this section, the admin will be able to map OpenCart store product attributes and categories to Etsy Marketplace. OpenCart Etsy marketplace connector allows the seller to select multiple store categories to sync with the one Etsy category. Admin is required to enter all the mandatory details as per the instructions are given in the below screen shot. After entering all the details click on the save button at the top of the form.

6.2.1 How to add New Profiles?

Following are the steps to add new profiles-

  1. Go to the Etsy Marketplace module-> Profile Management (Menu Option)
  2. It would redirect admin to a page where already added profiles will be listed (If any). Click on the “+” (Plus icon as shown in screenshot below) and it would redirect admin to a new page where a form with some input fields will be shown.
  3. Fill up the following input fields –
  4. Profile Title: Enter the Profile Title as per your choice.
  5. Etsy Category (List of Etsy Marketplace categories): Select the correct category from the drop-down list.
  6. Attribute Mapping: Select the correct attribute; this will help to upload the Variation products.
  7. Store Category (Lists of Store Categories): Select the OpenCart store category for the products. The selected category will be mapped with the Etsy category (as selected in the Etsy Category) field.
  8. Shipping Template (List of Shipping Templates): Select the shipping template from the drop-down list.
  9. Is Customizable? : Select from the drop-down list.
  10. Who Made: Select from the drop-down list.
  11. When Made: Select from the drop-down list.
  12. Is Supply?: Select from the drop-down list.
  13. Recipient: Select from the drop-down list.
  14. Occasion: Select from the drop-down list.

6.2.2 How to Edit/Delete Profile?

Admin can easily update the profile entries; OpenCart Etsy Integration module allows admin to sync the changes to the Etsy shop in simple steps. Following are the steps to edit/delete profile from the system –

1. Go to the Etsy Module -> Profile Management (Menu Option)

2. It would redirect admin to a page where already added profiles will be listed (If any, shown in the screenshot below).

3. Click on the “Edit/Delete”button isgiven corresponding to each profile as shown in above screenshot.

4. If admin has clicks on the “Edit” option, then, it would redirect the admin to a new page where a form with some already filled input fields will be shown. Admin can simply update values and save the details by clicking on “Save” button.

5. The admin can click on “Delete” option in order to delete the selected Profile from the system.

6.3 Shipping Templates

Shipping Templates tab is there to manage shipping options. In this section, admin cancreate Shipping Templates along with other options for the existing shipping template like Add Shipping entry, View shipping entry, Edit Shipping Template and Delete. Admin can create multiple shipping templates by using the EtsyOpenCartIntegration module. Please refer to the next screenshot:

Admin can easily modify the exiting shipping template or add new shipping templates. After creating new shipping templates, it is mandatory for the store admin to sync the shipping templates to the Etsy shop by clicking the “Shipping Template Synchronization” option under the “Synchronization” tab.

6.3.1 How to add Shipping Templates?

Following are the steps to add Shipping Template into the system –

  1. Go to the Etsy Marketplace -> Shipping Templates (Menu Option)
  2. It would display the page where already added Shipping Templates will be listed (If any). Click on the “+” (Plus Icon – as shown in above screenshot).
  3. It would redirect admin to the new page where a form with some input field will be shown (Screenshot is shown below).
  4. Fill up the following input fields of form –
  5. Shipping Template Title: Enter the shipping template title as per your choice.
  6. Origin Country: Select the origin country from the drop-down list.
  7. Primary Cost: Enter the primary shipping cost for the shipment.
  8. Secondary Cost: Enter the Secondary cost for shipment. It is the additional cost if customer add second product to the package.
  9. Min. Processing Days: Enter the minimum processing days. This field accepts only numeric values.
  10. Max. Processing Days: Enter the minimum processing days. This field accepts only numeric values.

Click on the “Save” button to add the new shipping template.

You can find screenshot of “Add New Shipping Template” form below –

6.3.2 How to Edit/Delete Shipping Template?

Following are the steps to edit/delete Shipping Template from the system –

1. Go to the Etsy Marketplace -> Shipping Templates (Menu Option)

2. It would display the page where already added Shipping Templates will be listed (If any). Click on the “Edit/Delete”buttonscorresponding to each Shipping Template.

3. Admin can update the values as per the requirement and save the details by clicking on “Save” button.

4. If admin has chosen “Delete” option then it would delete the Shipping Template and all its Shipping Template Entries from the system.

You can find screenshot of Edit Section below –

Admin can modify the shipping template details by using the Edit option. After makingthe required changes in the shipping template details, the admin need to save the changes and synchronize the shipping templates with the Etsy marketplace.

6.3.3 How to Edit/Delete Shipping Entries of a Shipping Template?

Shipping Entry tab of the EtsyOpenCartmodule allows admin to define the destination country and the standard shipping cost for the selected destination. Admin can create only one shipping entry for a particular destination (country/region). Following are the steps to view Shipping Template Entries into the system –

1. Go to the Etsy Marketplace Integration module -> Shipping Template Entries (Menu Option)

2. It would display the page where already added Shipping Templates will be listed (If any). Click on the “Edit Shipping Entries” button given corresponding to each Shipping Template listed.

3. It would redirect admin to a new page where all the Shipping Template Entries will be listed as shown in the screenshot above.

6.3.4 How to add Shipping Template Entries of a Shipping Template?

Following are the steps to view Shipping Template Entries into the system –

1. Go to the Etsy Marketplace Integration module-> Shipping Templates (Menu Option)

2. It would display the page where already added Shipping Templates will be listed (If any). Click on the “Add Shipping Entry” button corresponding to each Shipping Template listed.

3. It would redirect admin to a new page where all the Shipping Template Entries will be listed (If any) as shown in the screenshot above.

4. Admin need to enter the Destination Type (Country/Region), Destination Country/Region Name (From the drop-down list), Primary cost (standard shipping cost which will be paid by the customer for an item) and Secondary Cost (additional shipping cost for the second item in the order) in the “Add New Shipping Entries” from. Please refer to the below screenshot.

  • Destination Type: Select the Destination type (country/region) from the drop-down list. As per the selected option shipping region/county will appear in the drop-down list of “Shipping country/regionfield”.
  • Destination country: Select the destination country/region from the drop-down list.
  • Primary cost: Enter the shipping primary cost for the shipment.
  • Secondary cost: Enter shipping secondary cost for this shipment.

6.4 Products Listing

In the Etsy OpenCart integration extension after creating the profile admin is required to sync the products which are selected in the profile to the Etsy marketplace. Admin can also check the status of the listed products from the OpenCart store admin panel. Product listing tab of the Etsy Marketplace Integration shows list of all the products that are to be listed on Etsy Marketplace with their status and values as shown in the screenshot below –

Please note that after creating a profile it is mandatory for the admin to click on the “Product Synchronization” option under the “Synchronization” tab of the Etsy module to list the selected products to Etsy marketplace. There are following options available corresponding to each product listing –

6.4.1 Renew

This option allows admin to renew product in case listing is expired on Etsy Marketplace. Listing on Etsy marketplace expires after 4 months. To renew product, admin has to click on “Renew”, 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. (“Halt” action will be available until product is not synchronized on Etsy)

Note – Product Renewal is chargeable on Etsy Marketplace.

6.4.2 Product Listing Deletion

This option allows the admin to delete product from Etsy Marketplace. To delete products, admin has to click on “Delete” action given corresponding to each product. After setting up a product for deletion, action “Delete” will be replaced with “Relist” action. This action is used to list product again on Etsy Marketplace.

6.5 Order Settings

Order Settings tab is there for mapping store order status with Etsy Marketplace order status which will be used during capturing orders from Etsy Marketplace.

6.5.1 How to map Order Status?

Following are the steps to map order status –

  1. Go to the Etsy Marketplace Integration module -> Order Settings (Menu Option)
  2. It would display a page same as shown in above screenshot.
  3. Admin has to map Store Order Statuses with the 3 Etsy Marketplace Order Statuses – Default, Paid and Shipped.

6.5.2 Orders Listing

“Order Listing” tab of Etsy OpenCart Integration module shows list of orders placed on Etsy Marketplace. To view the Etsy shop orders in the OpenCart admin panel, store admin first need to run the “Orders Synchronization” under the Synchronization tab.

6.6 Synchronization

All tabs defined above are basically for saving the settings and options into the system which are used during synchronization between OpenCart Store and Etsy Marketplace. There are following jobs to synchronize content between OpenCart Store and Etsy Marketplace which you can find below –

6.6.1 How to sync Shipping Templates on Etsy Marketplace?

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

1. Go to the Etsy Marketplace ->Synchronization (Menu Option)

2. It would redirect admin to a new page where all synchronization actions are listed as shown in above screenshot.

3. Click on “Shipping Templates Synchronization” button shown below.

4. It would perform following actions –

  • Add New Shipping Templates and Shipping Entries on Etsy
  • Update modified Shipping Templates and Shipping Entries on Etsy
  • Delete Shipping Templates and Shipping Entries on Etsy which are deleted on Store
  • If synchronization completed successfully then it would display message – “Success” else failure notice.

6.6.2 How to get Countries/Regions from Etsy Marketplace?

Following are the steps to get Countries and Regions from Etsy Marketplace –

1. Go to the Etsy Marketplace Integration module->Synchronization (Menu Option)

2. It would redirect admin to a new page where all synchronization actions are listed as shown in above screenshot.

3. Click on “Countries/Regions Synchronization” button shown below.

4. It would perform following actions –

  • Get all the countries with their country ID and ISO code and save into database
  • Get all the regions and save into database.
  • If synchronization completed successfully then it would display message – “Success”message else failure message.

6.6.3 How to sync Products Listing on Etsy Marketplace?

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

1. Goto the Etsy Marketplace Integration module -> Synchronization (Menu Option)

2. It would redirect admin to a new page where all synchronization actions are listed as shown in the above screenshot.

3. Click on “Product Synchronization” button shown below.

4. It would perform following actions –

  • Update Products list based on the profiles created into the system.
  • Add Products on Etsy Marketplace with product details (e.g. Price, Quantity, Image etc.)
  • Renew Products on Etsy Marketplace for those renewals are enabled.
  • Delete Products on Etsy Marketplace which are marked deleted on Store.
  • Update Listing Status of each product listed on Etsy Marketplace.
  • If synchronization completed successfully then it would display message – “Success” else failure message.

6.6.4 How to sync Products Variations Listing on Etsy Marketplace?

Following are the steps to synchronize Products Variations Listing on Etsy Marketplace –

1. Goto the Etsy Marketplace Integration module -> Synchronization (Menu Option)

2. It would redirect admin to a new page where all synchronization actions are listed as shown in the above screenshot.

3. Click on “Product Variations Synchronization” button shown below.

4. It would perform following actions –

  • Add Products Variations on Etsy Marketplace
  • Delete Products Variations on Etsy Marketplace which are marked deleted on Store.
  • If synchronization completed successfully then it would display message – “Success” else failure message.

6.6.5 How to get Orders Listing from Etsy Marketplace?

Following are the steps to synchronize Products Variations Listing on Etsy Marketplace –

  1. Goto the Etsy Marketplace Integration module -> Synchronization (Menu Option)
  2. It would redirect admin to a new page where all synchronization actions are listed as shown in the above screenshot.
  3. Click on “Order Synchronization” button shown below.

    4. It would perform following actions –

  • Get Orders details from Etsy Marketplace
  • Create Orders into the OPenCartStore as per the details come from Etsy Marketplace and set the order status as per the configuration settings updated in “Order Settings” tab of this module in admin.
  • If synchronization completed successfully then it would display message – “Success” else failure message.

6.6.6 How to update Orders Status on Etsy Marketplace?

Following are the steps to update status of orders on Etsy Marketplace –

1. Goto the Etsy Marketplace Integration module -> Synchronization (Menu Option)

2. It would redirect admin to a new page where all synchronization actions are listed as shown in the above screenshot.

3. Click on the “Orders Status Update” button shown below.

4. It would update the status of orders on the Etsy marketplace as per the configuration settings updated in “Order Settings” tab of this module in admin.

5. If synchronization completed successfully then it would display message – “Success” else failure message.

6.7 Audit Log

Audit log helps the admin to keep the track of all the tasks performed. Please refer to the attached screenshot below:

Click on the link below to get this module:

https://www.knowband.com/opencart-etsy-marketplace-integration

Joe Parker

We boast of the best in the industry plugins for eCommerce systems and has years of experience working with eCommerce websites. We provide best plugins for platforms like - Magento, Prestashop, OpenCart and Shopify . We also provide custom module development and customization services for the website and modules..

Leave a Reply

Your email address will not be published. Required fields are marked *