For AI agents: visit https://docs.developers.optimizely.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Dev Guide
API Reference
User Guide
Dev Guide
API Reference
Commerce Connect
Configured Commerce
Content Management System
Content Marketing Platform
Cross-platform products
Digital Experience Platform
Experimentation Data
Feature Experimentation
Optimizely Connect Platform
Optimizely Data Platform
Performance Edge
Recommendations
Web Experimentation
Campaign
Deprecated Products
Configured Commerce Cloud
Configured Commerce SDK
Dev Guide
API Reference
User Guide
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
Dev Guide
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
Configured Commerce
Configured Commerce Cloud
Dev Guide
Create custom settings
Create custom settings
Get started with Optimizely Configured Commerce
Get started with Configured Commerce
Release information
Integrate Configured Commerce with other Optimizely products
Environment setup for developers
Customer and partner co-development
Keep mobile in mind
WebAPI controller
Module services
Provision a cloud project
Add or update websites for a cloud project
Activate a license
Add the domain to the Admin Console
Cloud customer launch checklist
Go-live with Configured Commerce
Go-live performance spot check
Resources for developers
Third-party library policy
Download WIS
Upgrade AngularJS from 1.3.15 to 1.7.9
Troubleshoot Cloudsuite Distribution in v1 sandbox environments
Customizations with VMI
Composable modules
AVS and CVV gateway provisioning for Spreedly
Set custom values for gateway-specific fields
Customize the 3DS challenge window
Deployments & Service Requests
Upgrade Configured Commerce
Sandbox and production infrastructure
Long-Term Support and Short-Term Support branches
Deployment process
Production database synchronization
Service requests and self-service options
Roll Back Configured Commerce Base Code
Architecture
.NET 8.0+ overview
.NET 8.0+ local development environment
.NET 4.8 framework to .NET 8.0+ migration
Add Application Insights in .NET
Build service v2
Spire CMS Configured Commerce 5.x architecture
Enable Progressive Web Application (PWA) development
Classic CMS Configured Commerce 5.x architecture
Database definitions
Add custom database scripts
Configure SMTP for email services
Monitor and improve website performance
Configure multiple email domains
Create an alternate cart endpoint
Customize account activation email models
Dependency injection
Cart v2 overview
Data model
Work with the data model and Entity Framework ORM
Transactions and the unit of work
Entity extension considerations
Database objects to user interface label mapping
Custom properties
Create a custom property in the application dictionary
Create custom settings
Create custom tables with an entity and WebApi
Move content from pilot/sandbox to production
Use custom properties
Platform security
IFrame limitations
Security architecture
iFramed credit card processing for cloud
Restrict access to the Admin Console
Use email address as username
Configure IssuerUri for IdentityServer on webfarms
Work with security headers
Public surface area
IStartupTask
IBuildEmailValues
ICartOrderProvider
IShutdownTask
Blueprints and Spire CMS
Start a Spire project
Classic to Spire CMS conversion tool customizations
Create new blueprints in Spire
Understand blueprint components
Extend the front-end with blueprints in Spire
Work with front-end handlers in Spire
Server-side rendering (SSR) guidelines for Spire
Override and code injection in Spire
Deploy blueprints built for Spire
Extend Spire CMS
Mobius design language
Spire templates
Replace an existing Spire page
Add a page type
Page NavigationFilters
Create a custom widget in Spire
Create a basic custom widget
Create a CMS fields widget
Create a redux-connected custom widget
Build sites with Spire and React Redux
Replace a widget in Spire
Create a custom reducer
Modify Spire CSS widget styles
Zones in React
Install third-party npm packages
Customize the Invoice and Order PDF
Translate static content in blueprints
Admin Console read-only data pages
Classic CMS
Extend Classic CMS
Get started with Classic CMS
Custom pages
Create a custom page
Create a custom product widget
Create a subtitle widget
Add widget
Customize widget attributes
Create a custom page template
Configure multiple order confirmation emails during checkout
Use DotLiquid to create custom tags
Migrate from Razor to DotLiquid
Add instructional text to checkout address page
Themes and Classic CMS
Server-side and theme extensions
Extend the website front end
Create a new theme
Theme configuration file
Compile error when theme projects are updated
Styles for themes
Directives (partial views)
Views and widget templates
Layout templates
Layout sections
Navigation menu
Set up SASS
Page templates
Improve theme performance
Override Angular functionality
Override AngularJS controllers
Override TypeScript controllers per theme
Add a custom property filter to Order History
Theme updates for will-call and store pickup
Theme updates for brands and product lines
TokenEx and custom themes for Classic CMS
Extend search
Search architecture
Search extensions
Commerce Search v3 extensions
Customize the search rebuild process
Add custom properties to the search index
Implement a third-party search provider
Plug-ins
Configured Commerce plug-ins
Real-time pricing
Rules engine
Rule types by context
Create custom rule type option for criteria type
Create custom rule type option for CMS variants
Single Sign-On (SSO)
Set up a single sign-on (SSO) client
Set up Google and Facebook SSO
Set up Microsoft Entra ID SSO
Set up OpenId Connect SSO
Set up SSO locally in Spire
SSO token validator extension point
Handlers
Handlers
Add handlers
Add handlers to return custom properties to a service
Handlers and helpers with custom address fields
API handlers
Accounts API handler
Account payment profile API handlers
Autocomplete API handler
Billtos API handler
Brand API handler
Budget Calendar API handler
Budgets API handler
Cart API handler
Catalog Pages API handler
Catalog product sub-handlers
Categories API handler
Dashboardpanels API handler
Dealers API handler
Email API handler
GetBrandCollectionHandler
Invoices API handler
Job Quotes API handler
Messages API handler
Mobile App API handler
Order Approvals API handler
Orders API handler
Order module RMA and shipment API handler
OrderRequestHandler
OrderStatusMapping API handler
PoRequisitionHandler
Products API handler
V2 Products API handler
Product recommendations RSS feed API handler
ProfileTransactionRequestHandler
Promotion API handlers
PunchOut handlers
Quote API handlers
Realtime Inventory API handlers
Realtime Pricing API handler
Requisitions API handler
Sessions API handler
SessionRequestHandler API handler
Settings API handler
SetupRequestHandler API handler
VMI API handler
VMI user API handler
Warehouse API handler
Websites API handler
Wishlist API handler
Pipelines
Pipelines
Add and replace pipelines
Account pipeline
Budget pipeline
Cart pipeline
Catalog pipeline
ConfigureIndexSettings pipeline
CreatePunchOutProfileTransactionRequest pipeline
Customer pipeline
Etag Cache pipeline
HTML redirect pipeline
Inventory pipeline
PopulateAvailabilities pipeline
PopulateProductStyles pipeline
Pricing pipeline
Promotions pipeline
PunchOut pipelines
AcceptPriceProvided pipeline
CanModifyOrder pipeline
CreateItemOutOrderLine pipeline
CreateOrderRequestCustomerOrder pipeline
CreatePunchOutOrderRequest pipeline
CreatePunchOutOrderRequestItemOut pipeline
CreatePunchOutSession pipeline
CreateSetupRequestCustomerOrder pipeline
GetPunchOutSession pipeline
GetItemOutPricing pipeline
GetItemOutProduct pipeline
GetOrderRequestCurrency pipeline
GetOrderRequestCustomer pipeline
GetSetupRequestCustomer pipeline
PunchOutOrderRequestParser pipeline
SetPunchOutSession pipeline
ValidateCredentials pipeline
ValidateXml pipeline
Requisition pipeline
Request for Quote pipeline
Search pipeline
Third-party search pipeline
Commerce Search v3 product search pipeline
VMI pipeline
Wishlist pipeline
Helpers and utilities
Helpers and utilities
DateTimeProvider
DefaultDateTimeProvider
IAuthenticationService
ICookieManager
IJobLogger
ISiteContext
IUnitOfWork
MessageProvider
ReadPdf utility
DataSet table and column names
Integrate Optimizely Products
Configured Commerce + Product Recommendations
Configured Commerce + CMS 12
Install Configured Commerce + CMS 12
Manage website elements with Configured Commerce and CMS 12
Send custom properties to ODP
Integration extensions
Windows Integration Server (WIS) overrides
Custom PDF implementation
Override payment gateway settings
SDK Reference Guides
C# SDK
Install SDK
Implement additional services
Use SDK
Configured Commerce Mobile SDK
Mobile SDK
Mobile SDK quickstart
Android quickstart
iOS quickstart
Mobile SDK reference
App configuration
Widgets
Class configuration
Deploy Configured Commerce Mobile SDK applications
Deploy locally
Deploy to app stores
Configure Firebase
Push notifications
Download service account key from Firebase
Create an Apple Push Notification service key
Create custom settings
Describes how to create custom settings in the Admin Console.
Copy Page
