Back to Top

eBay Akeneo PIM Connector

Updated 24 April 2024


eBay Akeneo Connector: With the help of eBay Akeneo Connector, you can create a product listing on the eBay marketplace using the Akeneo PIM platform.

eBay-Akeneo integration allows you to manage thousands of products easily.

You can connect your eBay store using multiple credentials, map categories, map product attributes, and do much more using multichannel PIM integration.

Basic Requirements:

  • This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.x, 5.x and 7.x. Download Akeneo from here
  • Node and Yarn packages need to be installed. Click Here
  • This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
  • If you want to use this extension on Akeneo EE Serenity mode, please contact us.
  • For the Akeneo installation, your Akeneo server should meet these system requirements.


  • List your products and product with variations on eBay from Akeneo
  • Works with multiple eBay account credentials
  • You can map Akeneo categories with eBay categories
  • You can map Akeneo product attributes with eBay product attributes
  • Set the default configuration value

Video Tutorials

Check out the following video tutorials below:

How to get an eBay credential in Akeneo?


How to do attribute mapping for eBay fields to Akeneo?


How to add simple products and export from Akeneo to eBay?



Two different types of module installation processes are available for the module.

Searching for an experienced
Akeneo Company ?
Find out More
  1. Composer Installation
  2. Manual Installation

Installation using Composer

Read This Blog

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository as well as the installation script.

For Akeneo 7.x

  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/ebayconnectorbundle/src/Webkul/EbayConnectorBundle/install/ COMPOSER=true NO_DOCKER=true"
        "post-install-cmd": [
           "vendor/webkul/ebayconnectorbundle/src/Webkul/EbayConnectorBundle/install/ COMPOSER=true NO_DOCKER=true"
        "post-create-project-cmd": [
          "vendor/webkul/ebayconnectorbundle/src/Webkul/EbayConnectorBundle/install/ COMPOSER=true NO_DOCKER=true"
  "repositories": [{
    "type": "composer",
    "url": ""

3: Use composer to install the extension.

composer require webkul/ebayconnectorbundle

4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.

Manual Installation for Version 7.x

  • After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
  • From the PIM directory, run the following command over the NO-DOCKER instance:.
./src/Webkul/EbayConnectorBundle/install/ COMPOSER=false NO_DOCKER=true
  • After that run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/EbayConnectorBundle/install/ COMPOSER=false NO_DOCKER=false

Manual Installation for Version 4.x to 5.x

Please follow these steps for installing the eBay Akeneo Connector module in your Akeneo PIM platform.

Step 1 – Unzip the respective extension zip then merge the “src” folder into akeneo project root directory.


Step 2 – Goto config/Bundles.php then add line:

Webkul\EbayConnectorBundle\EbayConnectorBundle::class => [ 'all'=> true],

in the return array.

Step 3 – After that, copy the “config” folder into the akeneo project root directory for routing.


Step 4 – Then run this command after ssh to your akeneo server by the terminal

php bin/console cache:clear--env=prod && php bin/console ebay:setup:install

5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

For Akeneo 5

sudo service php-fpm7.4 restart

For Akeneo 4

sudo service php-fpm7.3 restart

Docker Installation Command :

For Akeneo 5

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run update-extensions;
docker_yarn run less;

For Akeneo 4

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run less;

Module Installation for Version 2.x to 3.x

Please follow these steps for installing the eBay Akeneo Connector module in your Akeneo PIM platform.

  • Unzip the respective extension zip then merge the “src” folder into the akeneo project root directory.

Unzip the extension in root directory

  • After that goto app/AppKernel.php then add the following line in function registerProjectBundles()

Code add in AppKernel.php file

new Webkul\EbayConnectorBundle\EbayConnectorBundle(),
  • Goto app/config/routing.yml then add these lines at top of the file

Code in Routing.yml file

      resource: "@EbayConnectorBundle/Resources/config/routing.yml"
      prefix:   /
    • Then you have to navigate to Akeneo Installation Directory(Ex. cd /opt/bitnami/apps/akeneo/htdocs ). Run this command after ssh to your akeneo server by the terminal.
php bin/console cache:clear--env=prod;
php bin/console ebay:setup:install
  • After that, you have to restart your web server like Apache, Nginx. Run the command for the Apache webserver.
        sudo service apache2 restart
  • If you are using php-fpm. Then you need to restart the php-fpm services.

    sudo service php-fpm7.2 restart

Common Issues After Installation

It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

  • Webpack Installation: If you get the below error Webpack error It means that the web pack is not installed in your system. Run the following command
    npm install --save-prod webpack
    npm install
  • Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
  • Clear your browser cache.

Uninstall Module: For Akeneo 7.x

  • From the PIM directory, run the command below over the NO-DOCKER Instance.
./src/Webkul/EbayConnectorBundle/uninstall/ COMPOSER=false NO_DOCKER=true
  • Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/EbayConnectorBundle/uninstall/ COMPOSER=false NO_DOCKER=false


Follow the below steps to create eBay Credentials to be used in Akeneo

  • Sign in to your Akeneo account then go to the eBay connector.
  • After that, for credential setup, you have to click on create the credential icon. Then you need to fill in all details (App Id, Cert Id, Dev Id, User ID, Auth Token).
  • For these credentials, you have to visit

eBay developers Login Page

eBay register page

  • If you have already an account then go to the Sign-in option.

eBay Sign in Page

  • After the above setup, you need to enter an application title. You will get two links.

Enter an Application key

  • Create a keyset for Sandbox or Production. Click on create a keyset for Sandbox.

Enable sandbox mode

  • After that fill in the details then click on Continue to create the key.

Enter the details for keyset

  • Your Sandbox AppID(Client ID), Dev ID, and Cert ID(Client Secret) generated. Click on the create a keyset for Production.

Application Keys in eBay

  • Your Production keyset generated, click on the User Token in the Sandbox section.

User token in eBay

  • Click on the Sign in to Sandbox to generate a User Token.

Sign in for Sandbox

  • After that a new pop-up window opens, fill in the details.

Pop-up window for Token in eBay

  • Enter the username then password to sign in to the Sandbox after that Accept the eBay agreement.

Sign in Sandbox

ebay term and condition

  • After that you will get a user token here.

eBay token in Akeneo

  • Lastly, you will be redirected back then will get the Application keys.
  • Find all the details AppID(Client ID), Dev ID, Cert ID(Client Secret), and user token.
  • Now your connector is ready to use.

Setup Credential in Akeneo

After successfully installing the module in Akeneo, you need to set up the eBay API credentials in Akeneo.

Please log into Akeneo after that follow eBay Connector> Create Credential.

In this, you need to enter the Profile Name, Global Site ID, Mode, AppID(Client ID), Dev ID, Cert ID(Client Secret), and user token.


Now enter the credential.

  • Profile Name
  • Global Site ID
  • Mode
  • eBay Developer Dev ID
  • eBay Developer App ID
  • User Token
  • eBay Developer Cert ID


After click on the save button, you will get the configuration values icon. Here you have entered the values you want to show with the product.

Configuration Values –

Configuration values define all shopping-related details of the product. You can configure your common details, Listing details, Dispatch details, Return policy,  and Shipping details.

Common Details –

From the name, we can easily understand that Common details are the basic seller details like Payment methods, Paypal Email, Postal code, Country, and Currency.

  • Inventory Tracking Method – By using Inventory tracking methods you can easily search the product in your product listing. It is based on the SKU(Stock Keeping Unit).
  • Payment Methods – Nowadays different payment methods are available. So you can give more options to the customer for payment while purchasing.
  • PayPal Email Address – You have to enter your PayPal email address to complete the payments.
  • Postal Code – You have to enter your postal code as you mentioned in your Sandbox.
  • Country – You have to enter the country code where you want to sell the products.
  • Currency – You have to enter your currency code according to your country code.
  • Shipping Profile ID – You have to enter the Shipping profile id by which you can track the shipping details.
  • Return Profile ID – If you mention that the product is returnable then you have to give a Return Profile Id.
  • Payment Profile ID – For the tracking of successful payment you have to mention a payment profile id. By this, you can track your payment gateway details.


Listing Details –

Here you can configure all listing details like Listing type, Listing Duration, and Gallery type. It defines the product availability, variable product, and the place to store the products.

  • Listing Type – Listing type is about the product price by which you can define it. The product price could be a fixed price or variable.
  • Listing Duration – Here you can mention your product listing duration like after how much time it will be canceled.
  • Gallery Type – Gallery type describe where you want to store your product images and videos.


Dispatch Details –

  • Dispatch Time – Dispatch time is the maximum time to reach the product to the customer.

Return Policy –

  • Accepted Option – You can provide the option to return the product. A customer can return the product within the days if he gets a defective product.
  • Within Option(Duration) – Return within duration is the option in which a customer can return the product.
  • Within Option – This is the option that is applicable to both the customer and seller.
    Seller – Within the time a seller can return the product to the customer.
    Buyer – Within the time a buyer can return the product if he got the defective product.


Shipping –

  • Service Priority – Shipping service priority is the minimum number of days committed by the Shipping Service providers to deliver a product.
  • Shipping Service – Shipping service providers are those who transport the goods from one place to another or door to door.
  • Service Cost – You can mention the shipping cost of a product when delivering it to the customer.
  • Free Shipping – You can give free shipping options for a product. A customer doesn’t have to pay for it.
  • Shipping Service Additional Cost  – You can mention an additional cost for a specific product.

eBay Mapping Setting

In the eBay Mapping Setting tab, you need to match the product fields between eBay and Akeneo. Then you need to select the correct Akeneo attribute that matches the eBay product information.

  • SKU 
  • Product Title
  • Product SubTitle
  • Description
  • Quantity
  • Price
  • Condition ID 


Status mapping information remains the same on both ends. So if a product is disabled in Akeneo, it will be disabled on eBay as well.

Other Mapping:

In the other mapping, we can manage attributes to be used as Image and File.

Attributes to be used as Images – The selected Akeneo image attributes will be visible as eBay product gallery images. Please note – The images will export in sorting order they are selected here.

Item specifics (Attributes) – Item specifiers mean that the attributes specify size, weight, and color.


Category Mapping:

In Category Mapping, we map the Akeneo product category with the eBay product category. It helps you to add a product in eBay specific category. Then you can click on the right side of the screen Create Mapping.


Here you can create Akeneo eBay category mapping.


After that, you can see the mapping after adding a category mapping.


Create Product In Akeneo

To create a product in Akeneo, go to navigate to Products then click the Create button. Now, you need to choose the product type – as Product or Product Model.

Product – Select this type for creating simple and virtual products.

Product Model – Select this type for creating a configurable product with variations.

Create the product in Akeneo

Now enter the required SKU, choose a family, then click the Save button.

Product Family – A family is a set of attributes that will be the same for all products belonging to a family. The product family represents product type, imposes product information structure, and defines the list of attributes for a product that it belongs to.

Enter the sku and select the family in eBay

Add Product Details

Now you need to provide information about the product. First, select the Channel and Locale then enter the title, subtitle, description, and price.

Enter the product details

Select Attribute

For adding product information, select the attribute options you require. You can also create new options for the attribute. Following Attributes from Akeneo are supported for export:

  • SKU
  • Product Title
  • Product Subtitle
  • Color
  • Image
  • Weight
  • Description
  • Quantity

Add more attributes details

Add New Attribute Option

If an attribute option is missing for a select attribute type (simple or multi-select), you can directly add it to the Product Edit Form. Enter a Code and Label values, then click Save.

Add attribute option

Add Condition Id

When you add the product in Akeneo you have to enter the condition id which shows the product information like New Product, Used Product, New with defects, and Manufacturer refurbished. You can find her the value for these keywords.

Condition ID for product in eBay

In your product attribute section, you have to create an attribute for the condition. You have to click on the add icon.

Create a condition id

A pop-up will open you have to enter the code and label then click on the Save button.

Add the condition code and label

Upload Image

Click the upload picture section or use the drag and drop feature to add a product images.

Upload an Image in Akeneo

Multi-Lingual Information

Add information to other languages and store views.

Multilingual Information

Select Category

After entering all the product information, save your changes after that go to Product Navigation then select Categories.

Select product category in Akeneo

eBay Export Job

After that, to export your product data you need to create a job profile then execute it.

First, go to Exports> Create Export Profile after that enter a unique code, label, then select a job profile.

Create Export Profile

Job Profiles

Here you will find the export job profile:-

Product Listing Job – Product listing job profile exports everything (categories, attributes, attribute options, attribute group families, and products) based on filters in a job. A product must have a category to be included in the export job.

Choose export profile


eBay Active Credential

Here you will get all the active credentials made by you. You can select any active credentials for the product export process.

Manage the export profile

Filter The Data

After that go to the Content section then select the following options:

Channel – Each export job can only be linked to one channel, please select the relevant channel of products to export.

Select the channel

Locales – Select one or more Locales depending on your requirements.

Select the locales

Attributes – You can select which product attributes you want to export all or a few of them. Click the Edit button to select the attributes.

Attribute filter the data

Filter The Product

After that, you need to decide which products to export on eBay.

Filter the products


Select one or more product families to export to eBay. If you want to export products belonging to specific families, click on the drop-down list then click on the families to add in the field like clothing, shoes, t-shirts.

Filter the family

Time Condition

You can now export your product within a specific time condition.

Filter the product on time condition


After that you can configure the categories of the channel tree you want to export. For example, you want to export the clothing products to update.

Filter the product with category

By default, all categories are exported. To select a category, click on the Edit button the categories of the channel tree are displayed.

Select the category


You can make a selection of identifiers to export by adding them to the SKU field. You can copy and paste a list of identifiers, separated them by using comma, space, or line breaks.

Select identifier

After that click, the Save button then follow the next step to execute this profile.

Click to save the export profile

Export Now

After creating the export profile, click on the Export Now button. The execution of the export process will begin, the page will refresh continually to update the information.

Export the products

Execution Process

After that wait for the execution process to complete then check the errors. After the completion of the export job, the products will appear in the eBay product list.

Job Execution details

eBay Store

As you can see that the following products have been imported from Akeneo. The admin can view the products and make any changes in the product edit form of eBay.

eBay product listing details

You can click on the product to get full product details.

Product exported from Akeneo to eBay

Creating Product Variant

After that. to create a product with variations, go to Products>Create then select the Product Model.

select product model

Then, enter a Code, select Family, then select Variant. In Variant, you need to select how the variations will be created.

Create product Model

After that enter the basic product details which are common to all the variations. You can mention the product name, description, quantity, and price.

Product in Akeneo

Then to add a variation, click down the arrow symbol.

Select the variant

After that mention variant axis such as size, color then enters SKU for variation product.

Add a new ebay color

Once the variation product is created, you can mention Its details.

Variant product in Akeneo

After export of the product from Akeneo to eBay, you can see the product in the eBay product listing.

Variant Shirt in eBAy

When you select the variant color, you can see the variant product associated with it.


For any issues related to this module, please create a support ticket at- Also, for any pre-sales queries or customization discussion, please drop an email to [email protected]

Current Product Version - 3.0.0

Supported Framework Version - eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x ,3.2.x, 4.x, 5.x and 7.x

Blog Version - eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x ,3.2.x, 4.x, 5.x and 7.x
  • Version eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, and 2.3.x
  • Version eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x
  • Version eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x
  • Version eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x ,3.2.x, 4.x, 5.x and 7.x
  • Version eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x ,3.2.x, 4.x and 5.x
  • Version eBay Akeneo PIM Connector 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x ,3.2.x and 4.x
  • Version eBay Akeneo PIM Connector 2.0.5 or newer
. . .

Leave a Comment

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

Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home

Table of Content