nopCommerce Documentation

Omnisend integration

This section describes how to integrate the Omnisend plugin into your store. The plugin supports all versions of nopCommerce, including minor versions from 4.30 to 4.70.

What the Omnisend is

Omnisend is an email & SMS marketing automation platform that helps ecommerce stores to connect and engage with their customers. You can create popups and signup forms to collect new subscribers. Engage with them by taking advantage of channels like email and SMS. Use your store data to segment customers and drive sales with personalized automation.

What the Omnisend plugin does

Omnisend plugin for nopCommerce allows the store owner:

  • Synchronize contacts - performs synchronization of customers subscribed to the newsletter.
  • Synchronize products - synchronizes categories and products.

Install and enable the plugin

The Omnisend plugin is an out-of-the-box nopCommerce plugin. You can find it here: Configuration → Local plugins. To find the plugin faster, use the Group field in the search panel to filter the plugins by Misc type: Find the plugin

Install the plugin using the Install button if it is uninstalled. Then enable it by clicking the Edit button. You will see the Edit plugin details window in this case. Mark the plugin as enabled using the Is enabled checkbox and click the Save button.

How to configure the plugin

  1. Click the Configure button. You will see the Configure - Omnisend window: Configure - Omnisend

    To use Omnisend with nopCommerce, you will need to create an account with Omnisend. You can start with the free plan to explore platform features, no credit card needed.

    Note

    If you have been using Omnisend and already have an account connected to another store, make sure to create a new empty store first.

  2. To connect Omnisend to your store: Log into your Omnisend account.

  3. Click Connect store in the dashboard or in your account navigation menu Connect store - Omnisend

  4. Generate an API key and paste it into the appropriate field on the plugin configuration page. API key - Omnisend

  5. Click the Save button.

  6. Go to the Synchronization panel to synchronize your nopCommerce customers and products with your Omnisend account. Sync

What features are supported?

What data is synced?

The following store data will now be synced to Omnisend:

  • Customer details
  • Products and viewed categories
  • Order-related events
  • Abandoned cart-related events

Note

Manual synchronization should be performed only once, with multiple synchronization, batch insert will report data insert errors. Further synchronization will go automatically and will not require the participation of an administrator

Contacts sync

Two types of contacts synchronization are implemented in the plugin:

  • Initial import of all existing contacts. Performed when the user has just installed the plugin and wants to import all existing store contacts into the Omnisend account.

  • Contact synchronization when subscribing/subscribing.

Customer tracking events (JS snippet)

To track user actions in the store, a JS script is installed on all pages of the site. By default, the script tracks visits to all pages, including tracking visits to the product page. An additional script is also used to notify user identification.

Cart events, Order events

In the plugin track a number of events to notify the Omnisend service:

  • Adding a product to cart.
  • Placing an order.
  • Payment of an order.
  • Order refunded.
  • Canceling an order.
  • Finalizing the order processing.
  • Starting the checkout process.
  • Changing a product in the cart (increasing the quantity, discounts, etc.).
  • Deleting the last product from the cart.
  • Changing the order status.
  • Restoring cart. The user has the option to follow the link from the email Omnisend (abandoned cart reminder) to the store.

Products sync

The plugin implements import of categories and products. When you click the Sync products button, the synchronization process is performed.

Note

If there are many categories (>300), the user will be shown a warning that the import may take a long time.

In addition to the initial import, real-time synchronization of products is implemented, but only changes in the StockQuantity parameter are tracked to keep the product status (inStock, outOfStock, notAvailable) up to date.

Contributors: DmitriyKulagin
Edit on GitHub