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

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

PunchOut handlers

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
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
Themes and 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

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
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

Configured Commerce Mobile SDK

Mobile SDK
Mobile SDK quickstart
- Android quickstart
- iOS quickstart
Mobile SDK reference
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

PunchOut handlers

Lists resources related to PunchOut handlers.

OrderRequestHandler
PoRequisitionHandler
ProfileTransactionRequestHandler
SessionRequestHandler
SetupRequestHandler
PunchOutPipeline

System Status
Privacy Notice
Website Terms of Use
Cookie Settings
Trust Center
Third-Party Addons & Platforms
API, SDK, & MCP Terms