HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Serializable carts

Describes how to store cart data in a single table to load, update, and save cart information in Optimizely Commerce (PaaS).

In the SerializedCarts data model, all cart data is stored in one table, SerializableCart. This table contains these defined and searchable columns:

  • CartId
  • Created
  • Modified
  • Name
  • CustomerId
  • MarketId (Commerce (PaaS) 11.0 and higher)
  • Data

The Data column is where all the cart data is serialized to JSON format and stored as a string.

Serializable components

All cart data is serialized to a JSON formatted string before persisting it to the database. To achieve this, several cart components participate in the serialization/deserialization, which takes IMarket as a parameter.

Add custom data

Serializable components implement the IExtendedProperties interface, and custom values can be added to the Properties collection on the Serializable components as long as the value can be JSON serialized.

Converting a serialized cart with custom properties to a purchase order requires the Meta Fields corresponding to the custom properties to be present on the purchase order type. See Extend order classes.

The mapping between the serialized cart's custom properties and the purchase order's corresponding meta fields is strictly based on property name. The serialized cart is created with an empty Properties on, meaning it is not prepopulated with the keys or default values of the meta fields added to the purchase order or the legacy cart metaclass.

Enable SerializedCarts

By default, the SerializedCarts mode is enabled for a new installation site.

You can use ApplicationOptions to enable/disable SerializedCarts feature:

{
       "ApplicationOptions":{
          "Features":{
             "SerializedCarts":{
                "Feature":"SerializedCarts",
                "State":1, // 0 is enabled, 1 for disabled
                "Type":"Mediachase.Commerce.Core.Features.SerializedCarts, Mediachase.Commerce"
             }
          }
       }
    }

Alternatively, enable the SerializedCarts mode programmatically by adding the following to your InitializeModule class:

ServiceLocator.Current.GetInstance<IFeatureSwitch>().EnableFeature(SerializedCarts.FeatureSerializedCarts);