HomeDev guideRecipesAPI ReferenceGraphQL
Dev guideUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Install Configured Commerce + CMS

Install Configured Commerce + Optimizely Content Management System.

Follow these steps to install Configured Commerce, Optimizely Content Management System (CMS), and a reference site for you to use as a starting point when you’re ready to begin building out your website.

See the Configured Commerce + CMS User Reference for a list of the actions users should perform in each system.

How Configured Commerce + CMS work together

CMS is the front-end of an eCommerce website and Configured Commerce is the back-end. Manage content in CMS and leverage Configured Commerce to manage, products, users and other functionality on the back-end. CMS leverages the APIs in the Configured Commerce C# SDK in a headless manner to expose Configured Commerce data and capabilities within CMS. (See the C# SDK quickstart guide.)


Before you install anything, make sure you meet these prerequisites:
• Licenses for both CMS and Configured Commerce (2 separate products)
• CMS v12 (or higher)
• Configured Commerce 5.1 or later
• .NET 6 SDK (if you’re working with the deployment)

Step 1 – Install Configured Commerce

Be sure to set up some sample products, images and categories before starting on the CMS installation. You will need the sample data to know if the systems are working together correctly.

Follow instructions here:
Get started with Configured Commerce

Step 2 – Install CMS

You can use install a sample site and create an empty starter project after you set up your developer environment.

Follow instructions here:
Get started with CMS

Step 3 – Install Configured Commerce + CMS reference kit

The reference kit offers a starting point for you to build on when using Configured Commerce with CMS. The reference kit is not a sample site or a template.

Follow instructions here (be sure to reference the Readme file):
Configured Commerce + CMS reference kit

Step 4 – Build out website

Use the reference kit, in conjunction with the Configured Commerce C# SDK and related documentation, to begin building your eCommerce website.

Visit Optimizely Academy and search for the CMS Developer and Configured Commerce Developer learning paths.

Step 5 – Manage upgrades

Before upgrading CMS, review the APIs to ensure Configured Commerce is delivering the data, then proceed with the upgrade. Keep in mind the release schedule of both systems:
• Configured Commerce releases monthly and requires websites to keep up with a 3-month sync schedule. See Cloud release schedule article.
• CMS releases weekly and you can upgrade based on customer needs. See the Releases page.

Upgrade CMS ( version 12)
Configured Commerce Cloud release schedule


You can submit a support ticket for both Configured Commerce and CMS to Optimizely Support. Please indicate on your ticket that you are using both systems together and be specific about where the errors are occurring.