Child pages
  • OXID Connect 2.0. Module Tutorial
Skip to end of metadata
Go to start of metadata


Your customers expect high quality recommendations. They want to be supported in their purchasing decision and selection process. By using Yoochoose recommendations you increase the usability and the level of professionalism in your online shop. The recommendations present products to the customer he did not anyhow expect to find - in contrast to search.

If you are not familiar with the usage of recommendations, please read at least the two first pages of the Yoochoose User Guide [1]. Otherwise you can proceed with the following steps.


OXID eShop version

  • CE > 4.7.x
  • EE, PE 5.x

Network and Firewall Configuration

The OXID Recommendation module needs connection to the following endpoints:


Both http (port 80) and https (port 443) ports must be open for outbound TCP connections. One must not build the firewall rule based on IP. The Yoochoose infrastructure is located in the AWS cloud and IP addresses can be changed.

The OXID recommendation module loads recommendations using JavaScript after the shop page is already rendered. If the Yoochoose infrastructure is not available, it won't affect the loading time of OXID webpages.


Download the Yoochoose module package from the yoochoose Bitbucket repository under Copy the content of the folder src/plugins/oxid into the modules folder of your OXID installation.

The structure should look like following:


The folder structure of having a yoochoose inside another yoochoose folder is correct.

If you have a subfolder 'Mediaopt' inside the modules directory, please remove it. It is an old version of the plugin.


In the OXID administration backend go to

/Extentions/Modules/Yoochoose Recommendations

and click on the button "Activate".

After it was done, refresh the Browser Window (F5). A new menu element /Yoochoose must appear under the menu Service.


In the OXID administration backend go to


and click on the button 

Register new Yoochoose account

Register an account 

Assure that Oxid Connect is selected

After a successful registration process you will receive a <customer-ID> and a <license-key> by mail. Add this information into the corresponding fields in the module configuration page



Default recommendation settings are preconfigured and you can start tracking user data.

The customer ID and the license key can also be obtained later in the YOOCHOOSE backend under Login is the email address you have used in the registration process.

Please be patient. After the plugin is activated it takes about a day, until the first recommendations are available. The recommendation engine needs to collect statistic information before high quality recommendation can be provided. If enough tracking data is available, they will be rendered in your shop.

Structure and Functionality

The recommendation module is configured with default recommendation boxes throughout the OXID shop:

  • Landing-Page "Bestsellers" with most popular products
  • Landing-Page "Recommendations for You" recommendation based on one's shopping taste
  • Category-Page "Bestsellers" with most popular products in the current category
  • Product Detail Page "What other customers bought" with recommendations that others bought with the currently displayed one
  • Product Detail Page "You may be interested in" with recommendations of alternative products that were often viewed together with the current one
  • Shopping Cart recommendations with products that fit to your shopping basket

Landing page


Detail Page

Shopping Cart

Disabling Embedded Recommendation

Several database-intensive cross selling boxes are available in OXID out of the box which should be deactivated. It can be done in the OXID admin backend in

/Master Settings/Core Settings/Performance/Enhanced Performance Settings

  • No labels