Custom Connectors

The Cloudshelf Omnichannel API has been built from the ground up to support Custom Connectors.

This means that you can build your own connectors to any eCommerce platform, and use them with Cloudshelf.

How do Custom Connectors work?


A connector is a small piece of software that connects to an eCommerce platform, and transforms the data into a format that Cloudshelf can understand.

Your connector is then hosted on a server, and it should periodically check for updates to the eCommerce platform, and update Cloudshelf accordingly.

The general flow of data is as follows:

  • Provide theme data to Cloudshelf
  • Provide retail location data to Cloudshelf
  • Provide product data to Cloudshelf
  • Provide product group data to Cloudshelf

Cloudshelf will then automatically create your first Cloudshelf for you.

We don't currently have a template for building connectors, but we do have an open source Shopify Connector that you can use as a starting point.

To be able to use your connector with Cloudshelf, you will need to authenticate your requests using your API Key.