Knowband Blog | Ecommerce Modules

Magento eBay Integrator – User Manual

Joe Parker

1.0 Introduction

Magento eBay connector offers the quickest means to the Magento store owners to integrate their store with the very popular eBay marketplace. The eBay integration allows the merchants to manage the inventory and orders from a single interface.

Headquartered in San Jose, California, eBay is a multinational eCommerce corporation that popular as an online auction and shopping site. It facilitates consumer-to-consumer and business-to-consumer sales and offers an easy and customizable interface for the sellers across the globe to list and sell their products effortlessly. eBay operates in over 30 nations. The product listing of eBay combines 800+ million product listings that are not just unique but are even coupled with great deals.

Magento eBay Marketplace Integration module by KnowBand offers a smart solution to the e-merchants to integrate their store with the eBay Marketplace. The store admin can list products to the marketplace and sync the orders from the marketplace to their Magento store.

1.1 Merchant benefits of Magento eBay Integrator by Knowband 

2.0 Installation of Magento eBay Integrator

Follow the following steps for installing eBay Magento Marketplace integration extension:

1. Download the Magento eBay integration extension package.

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 the admin panel, go to eBay Marketplace in the main menu.

4. The Magento eBay Marketplace Integration module is now ready for use.

This User Manual will guide the users through the Magento eBay integration extension configuration and settings.

2.1 eBay Marketplace Integration- Seller Account Setup

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


3. After filling valid data click on join and you will be redirected to the application creation page.

4. Enter the application name and click on ‘Create a keyset’ under the Production section, a new form will be opened.

5. Enter the details and click on Continue to create Keys.

6. Application keys will be shown.

7. To create user token, click on User Tokens link in the above image.

8. Click on ‘Sign in to Production’ to get a token.

9. Fill the details and click on “Sign in to eBay to get a Token’”.

10. Sign into already created eBay Seller account or register as shown below:

1. On clicking register and filling details you will be redirected to your Seller eBay account.

2.2 To Get a token from eBay via your application

1. To create user token, click on User Tokens link in the below image.

Steps to reach this screen:-

A. Login into your developer’s eBay account.

B. On a successful login, you will see the below-added screen.

2. Click on “Get a Token from eBay Via Your Application.”

Steps to reach this screen:-

A. Click on “User Tokens” from the above screen.

3. Click on add eBay redirect URL and fill the form and save.

4. On clicking I agree from the right side form, you will be redirected to the authentication page.

3.0 Admin Interface of Magento eBay Integrator

Admin panel of the Magento eBay API Integration extension offers 8 configuration options.

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

3.1 General Settings

Once you have created a seller’s account, you need to fill-up the form to validate the synchronization of the store with the marketplace. Navigate to Admin Interface>eBay Marketplace>General Settings.

Fill the form shown in the General settings section. Each field for the configuration panel of Magento eBay Integration plugin is explained below:-

1. Enable/Disable

Enable/disable the Magento eBay API integrator by toggling this button.

2. Account Type

The admin can either choose the Sandbox account or the Production eBay account. The sandbox account is for testing purposes. While the Production account is for the final store integration.

3. Dev Id

Enter the Dev ID of your eBay account in this section. To find your Dev ID, sign in the eBay developer account. In the application key section, you’ll find App ID, Dev ID, and Cert ID as shown in the image below.

4. App Id

Copy the App ID from your eBay account and copy the same in this field.

5. Cert Id

Enter the Cert Id of eBay account in this section. You can find the Cert Id as shown in the above image.

6. RU Name

Enter the RU Name of the eBay account. To obtain your RU name, go to the ‘Get a Token from eBay via Your Application’ tab after adding a redirect URL.

7. Access Token

Copy the Auth Token of eBay account and paste in this section. To get the access token, you need to click on Sign in to Production as shown in the below image.

Sign in to the account from the form below:-

Click on I agree and get access tokens.

8. Paypal Email

Enter a valid PayPal ID connected to your eBay account. Follow the steps mentioned below:

1. Log in to your eBay seller account.

2. Click on account settings from top left dropdown an click on Paypal account.

3. Now Sign up or link your already created PayPal account with the eBay seller account.

4. On clicking Sign Up, you will be redirected to the PayPal account creation page. Just create a profile by filling the details and link it to your seller’s account.

3.2 Profiles Management

The Magento eBay Marketplace Integrator plugin offers an option of the profile-based product listing. The profiles created in the admin interface of the Magento to eBay integration plugin can be viewed in this tab. The admin can create a new profile and edit or delete the already created profiles.

3.2.1 How to Add New Profiles?

Follow the steps, to create new profiles, Go to the Admin Panel>eBay Marketplace>Profile Management.

Click on the ‘Add New’ button as shown below:

The profile creation tab of the Magento eBay Integration plugin is categorized into three tabs. They are:

3.2.1.1 General Settings

Once the eBay site is selected, the store admin is required to enter the following information.

eBay Currency: The currency will be automatically selected as per the eBay site selected by the admin. The store admin can even change the currency if required.

Store Language: The store admin needs to select the language as per the selected eBay site.

Shipping Template: The shipping options created in the Shipping Template Tab will be listed here (See Section 1.2.7). Select the shipping option that you want to display to the marketplace customer.

Attribute Mapping: Select the attributes based on which you want to create product variations.

eBay Category: Select the eBay category from the dropdown menu in which you want to map the categories of the store.

Store Categories: Check the categories that you want to map in the selected category of eBay. The Magento eBay integrator allows the admin to map multiple categories of the Magento store with a single category of eBay. To list multiple eBay categories, you are supposed to create multiple profiles.

Listing Duration: Select the duration for which the products of the profile is to be listed in the marketplace.

Product Condition: The default conditions are listed in the drop-down menu. Select the condition of your product.

Product Quantity: Enter the quantity of the product here.

Maximum Product Dispatch Time: Enter the maximum expected product dispatch time.

Allowed Payment Methods: Select the payment methods that you want to allow for this particular profile.

3.2.1.2 Profile Returns

The store admin can manage the return requests of the marketplace from the back-end of the eBay Magento API integrator. Here are some of the customization options offered in this tab.

Return Allowed: Enable the button if you want to allow return option in this profile.

Return Within: Enter the maximum number of days within which the return request should be initiated.

Refund will be Processed As Select how the refund will be offered to the customer.

Return Shipping Paid by?: Select who will pay for the shipping cost of the returned product.

Return Description: Enter a short description for the return option here.

2.3.2.1.3 Profile Specifics

Profile specifics will appear as per the category of the eBay selected in the General Setting tab of the Profile Management. This tab includes fields like Type, Brand, Model, Color, Features, and others. Fill up the fields as per the category selected and the product mapping will be done accordingly. The specifics marked by * are mandatory. Other specifics can be left blank.

3.2.2 How to Edit/Delete the existing Profile?

Templates will be listed (If any) in the Profile Management tab of the Magento eBay integration extension. Click on the ‘Edit or Delete’ button to edit/delete the profile as shown in the image:

The Profiles can be enabled/disabled by selecting the option in the ‘Active’ tab.

3.3 Orders Listing

The orders received from the marketplace will be synced to the Magento store once the cron is executed in the Synchronization tab. (See Section 1.2.7)

The orders listed as shown in the image below. To view the details and process the same click on the ‘View’ button corresponding to each order.

The store admin can now 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 Magento merchants can generate the invoice of the order. Once the invoice is created, the processing of the order will be initiated.

2. Credit Memos: Change the status of the credit here.

3. Shipments: The admin can update the shipment details in this section.

3.4 Orders Settings

The Magento eBay connector offers two-way integration. The admin can mark which status will be displayed when an order is synced.

It includes three options:

Order Default State: Select the default status of the orders that will be displayed in the marketplace.

Order Paid State: Select the status of the paid orders.

Order Shipped State: Select the status for shipped orders.

Note –

To update the change in the order status by executing cron in the Synchronization tab of the Magento eBay Marketplace integration plugin. (See Section 1.2.7)

3.5 Product Listing

The store admin can view all the products listed in the marketplace from the Product Listing tab of the Magento eBay Integration extension.

Here are some of the listing options offered in this tab of the Magento eBay Integration plugin.

Revise

The store admin can click on the ‘Revise’ button to update any change in the product detail. Whether you make a change in the product description, pricing or quantity of the products, all the changes will be updated in the marketplace by this button.

Delete

This option allows the admin to delete the product from eBay Marketplace. Click on “Delete” action corresponding to each product listing if you want to remove it from the eBay.com.

Relist

The ‘Relist’ option allows the admin to relist the products that have expired or have been removed from the marketplace.

The admin is supposed to run the respective cron after clicking on these action buttons to sync the changes with the marketplace.

View Error

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

Adding products from the product listings tab

If you want to add a product in the product listing tab, the admin has to create a profile of the product in the Profile section of the module. (read section 3.2.1) There you will get a step by step procedure of creating a profile and adding the product in the products listing tab.

Different statues in the filter of the product listing

Here are some different statues in the filter of the product listing.

3.6 Shipping Templates

The Magento store admin gets to create N number of shipping template from the back-end of Magento eBay Integration extension.

3.6.1 How to create New Shipping Templates?

To create new shipping templates, click on the ‘Add New’ button.

You’ll be redirected to the shipping template creation page.

Fill the below-mentioned fields for domestic shipping:

3.6.2 How to Edit/Delete Shipping Templates?

The admin can edit/delete the shipping template by entering the Edit or Delete button as highlighted in the image below:

3.7 Synchronization

The Magento to eBay integration allows easy synchronization between both the stores. All the synchronization jobs can be performed from this tab.

The synchronization tab of the Magento eBay Integration module offers three synchronization options. That is Product, Order and Shipping synchronization.

3.7.1 How to sync the products on eBay Marketplace?

Click on the “Sync Product” button as shown below.

It will add products in the marketplace with the respective product details.

3.7.2 How to Relist the product on the eBay Marketplace?

Click on the “Relist Products” button as shown below.

This will relist the expired products in the marketplace. It will update the listing of the products whose relisting was initiated in the Product Listing tab.

3.7.3 How to Revise the product on the eBay Marketplace?

Click on the ‘Revise Product’ as shown below to revise the products on the marketplace. Any change in the product details, image, pricing, etc can be synced by executing this cron offered by Magento eBay Integrator.

3.7.4 How to Remove a product on the eBay Marketplace?

Click on the ‘End Product’ as shown below to remove products from the marketplace. The admin has to click on the ‘Delete’ button in the products listing tab before executing this cron eBay Magento Integrator.

3.7.5 How to Import the listing report from the eBay Marketplace?

By executing ‘Get Products Listing Report’, the admin can import the report of the product listing from the marketplace. The eBay status column will be filled when this action is executed Magento eBay Integrator.

3.7.6 How to sync Orders from the eBay Marketplace?

Click on the “Sync Orders” button as shown below.

It would perform the following actions:

3.7.7 How to sync Order Status to the eBay Marketplace?

Click on the “Update Order Status on eBay” button as shown below.

It would perform the following actions

3.7.8 How to sync Shipping Methods to eBay Marketplace?

Click on the “Sync Shipping Methods” button shown below. It will sync all the shipping methods created in the Magento eBay Marketplace integration plugin to the eBay marketplace. This is a one time process.

3.8 Audit Log

This tab offers an overview of all the tasks being performed in the back-end of the Magento eBay Integrator extension.