Optimizely Commerce Connect

https://docs.optimizely.com/commerce-connect-14/docs
Admin
Optimizely Commerce Connect is an ecommerce platform for building and deploying online stores,...
Tokens:285,793
Snippets:2,431
Trust Score:10
Update:21 hours ago
Show doc for...
Tokens:
Raw
### promotion_dynamic_update Example Request (Get editable properties)

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request for the promotion_dynamic_update tool to retrieve editable properties by providing only the promotion ID.

```json
{
  "Id": "456"
}
```

--------------------------------

### Common OrderSearchOptions setup

Source: https://docs.optimizely.com/commerce-connect-14/docs/searching-for-orders-using-ordercontext

Defines common search options used by all following examples. Sets StartingRecord to 0, RecordsToRetrieve to 10000, and Namespace to "Mediachase.Commerce.Orders".

```csharp
OrderSearchOptions searchOptions = new OrderSearchOptions();
    searchOptions.StartingRecord = 0;
    searchOptions.RecordsToRetrieve = 10000;
    searchOptions.Namespace = "Mediachase.Commerce.Orders";
```

--------------------------------

### promotion_detail Example Request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request for the promotion_detail tool, retrieving details for a promotion by its name or ContentReference ID.

```json
{
  "Identifier": "20% Off Electronics",
  "IncludeAdditionalDetails": true
}
```

--------------------------------

### Install EPiServer.Commerce.Core NuGet package

Source: https://docs.optimizely.com/commerce-connect-14/docs/authorizetokenex-installation-and-configuration

Run this command in the Package Manager Console to install the EPiServer.Commerce.Core package, a prerequisite for building the AuthorizeTokenEx project.

```powershell
Install-Package EPiServer.Commerce.Core
```

--------------------------------

### Install Episerver CLI Tool globally

Source: https://docs.optimizely.com/commerce-connect-14/docs/setting-up-your-development-environment

Installs the EPiServer.Net.Cli tool globally from the Optimizely NuGet feed. Requires .NET 6.

```javascript
dotnet tool install EPiServer.Net.Cli --global --add-source https://nuget.optimizely.com/feed/packages.svc/
```

--------------------------------

### promotion_update Example Request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request for the promotion_update tool, updating basic promotion properties such as name, active status, and priority.

```json
{
  "Id": "456",
  "Name": "Buy 2 Get 1 Free - Extended",
  "IsActive": true,
  "Priority": 5
}
```

--------------------------------

### promotion_dynamic_update Example Request (Update properties)

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request for the promotion_dynamic_update tool to update promotion properties using property paths with underscore notation for nested properties.

```json
{
  "Id": "456",
  "Properties": {
    "Condition_RequiredQuantity": 3,
    "Discount_Percentage": 25.0,
    "IsActive": true
  }
}
```

--------------------------------

### promotion_filter Example Request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request for the promotion_filter tool, filtering promotions by name, active status, and target markets.

```json
{
  "Name": "discount",
  "IsActive": true,
  "Markets": ["US"]
}
```

--------------------------------

### Configure services in Startup.cs

Source: https://docs.optimizely.com/commerce-connect-14/docs/optimizely-graph-for-commerce-connect

Adds the required services for Content Delivery API, Content Graph, and Commerce Graph in the ConfigureServices method.

```csharp
services.AddContentDeliveryApi();
services.AddContentGraph(x =>
{
    x.IncludeInheritanceInContentType = true;
    x.PreventFieldCollision = true;
});
services.AddCommerceGraph();
```

--------------------------------

### Get cache-skipping IInventoryService instance

Source: https://docs.optimizely.com/commerce-connect-14/docs/warehouses-and-inventories-examples

Use IInventoryService.GetCacheSkippingInstance(IEnumerable<string>) to obtain an IInventoryService that skips the cache on reads. The example uses ServiceLocator to get the default instance and then calls GetCacheSkippingInstance.

```csharp
// Gets an instance of IInventoryService that will skip the cache on reads. 
public IInventoryService GetCacheSkippingInstance() 
  {  
    var inventoryService= ServiceLocator.Current.GetInstance<IInventoryService>(); 
    return inventoryService.GetCacheSkippingInstance(); 
  }
```

--------------------------------

### promotion_create Example Request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request for the promotion_create tool, creating a promotion within a campaign. Requires Name, Campaign, and PromotionType (full type name from promotion_types_list). Returns a confirmation dialog before creation.

```json
{
  "Name": "Buy 2 Get 1 Free",
  "Campaign": "Summer Sale 2024",
  "PromotionType": "EPiServer.Commerce.Marketing.Promotions.BuyQuantityGetFreeItems",
  "Description": "Buy any 2 items, get 1 free"
}
```

--------------------------------

### Create a meta-field with MetaFieldBuilder

Source: https://docs.optimizely.com/commerce-connect-14/docs/metafieldbuilder-class

Example of using MetaFieldBuilder to create a meta-field. The Edit scope is automatically opened. The example creates a DateTime, Text, Guid, and Integer field, then calls SaveChanges().

```text
using (MetaFieldBuilder builder = new MetaFieldBuilder(metaClass))
      {
        builder.CreateDateTime(CreatedFieldName, CreatedFriendlyName, false, true);
        builder.CreateText(CreatorFieldNameText, CreatorFriendlyName, false, 50, false);
        builder.CreateGuid(CreatorFieldNameGuid, CreatorFriendlyName, false);
        builder.CreateInteger(CreatorFieldNameInteger, CreatorFriendlyName, false, -1);
        builder.SaveChanges();
      }
```

--------------------------------

### Sample initialization module (C#)

Source: https://docs.optimizely.com/commerce-connect-14/docs/initialization

Use this module to register catalog content routes during initialization. It depends on EPiServer.Commerce.Initialization.InitializationModule and implements IInitializableModule. The Initialize method calls MapRoutes, which uses CatalogRouteHelper.MapDefaultHierarchialRouter.

```csharp
using System.Web.Routing;
using EPiServer.Framework;
using EPiServer.Commerce.Routing;
using EPiServer.Framework.Initialization;

namespace CodeSamples.EPiServer.Commerce.Catalog
  {
    [ModuleDependency(typeof(global::EPiServer.Commerce.Initialization.InitializationModule))]
    public class RegisterRoutingModuleSample : IInitializableModule
      {
        public void Initialize(InitializationEngine context)
          {
            MapRoutes(RouteTable.Routes);
          }
        private static void MapRoutes(RouteCollection routes)
          {
            CatalogRouteHelper.MapDefaultHierarchialRouter(routes, true);
          }
        public void Uninitialize(InitializationEngine context) { /*uninitialize*/}
        public void Preload(string[] parameters) { }
      }
  }
```

--------------------------------

### Configure AI for product properties in Startup.cs

Source: https://docs.optimizely.com/commerce-connect-14/docs/configure-ai-generated-product-descriptions

Add this code to the ConfigureServices method in Startup.cs to enable AI generation for specified product model properties. Use UseOpalAIForProperties for multiple properties and UseOpalAIForProperty for a single property. Replace FashionProduct, FashionBundle, Description, and LongDescription with your own models and properties.

```csharp
services.Configure<TinyMceConfiguration>(config => 
{ 
    config.UseOpalAIForProperties<FashionProduct>(x => x.Description, x => x.LongDescription); 
    config.UseOpalAIForProperty<FashionBundle>(x => x.Description); 
}); 
```

--------------------------------

### Get a single inventory record

Source: https://docs.optimizely.com/commerce-connect-14/docs/warehouses-and-inventories-examples

Use IInventoryService.Get(string, string) to retrieve a single inventory record for a catalog entry and warehouse. The example calls Get() without arguments, which likely uses default parameters.

```csharp
// Gets a single inventory record. 
public InventoryRecord GetAnInventory() 
  { 
    var inventoryService = ServiceLocator.Current.GetInstance<IInventoryService>(); 
    return inventoryService.Get(); 
  }
```

--------------------------------

### Get validator properties request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request body for the get_validator_properties tool. Requires PromotionType (campaign or promotion type name). Returns properties that have validation requirements.

```json
{
  "PromotionType": "BuyQuantityGetFreeItems"
}
```

--------------------------------

### Create new SKU using IContentRepository

Source: https://docs.optimizely.com/commerce-connect-14/docs/catalog-content

Shows how to create and publish a new SKU as IContent. Uses ServiceLocator to get IContentRepository, gets a default instance of CatalogContentTypeSample, sets required properties, and saves with SaveAction.Publish.

```csharp
public ContentReference CreateNewSku(ContentReference linkToParentNode)
      {
        var contentRepository = ServiceLocator.Current.GetInstance<IContentRepository>();
        //Create a new instance of CatalogContentTypeSample that will be a child to the specified parentNode.
        var newSku = contentRepository.GetDefault<CatalogContentTypeSample>(linkToParentNode);
        //Set some required properties.
        newSku.Code = "MyNewCode";
        newSku.SeoUri = "NewSku.aspx";
        //Set the description
        newSku.Description = "This new SKU is great";
        //Publish the new content and return its ContentReference.
        return contentRepository.Save(newSku, SaveAction.Publish, AccessLevel.NoAccess);
      }
```

--------------------------------

### Appsettings.json configuration example for Optimizely Commerce Connect

Source: https://docs.optimizely.com/commerce-connect-14/docs/feature-specific-commerce-configurations

Example configuration from the Optimizely Commerce 'Foundation' sample site. Shows the structure of the 'Commerce' section in Appsettings.json with options for handlers, plugins, meta objects, search, catalog, and other features.

```json
{
  "Commerce": {
    "BusinessManagerOptions": {
      "Handlers": [
        {
          "MetaClass": "Contact",
          "Method": "*",
          "TypeName": "Mediachase.Commerce.Customers.Handlers.ContactRequestHandler, Mediachase.Commerce"
        }
      ],
      "Plugins": [
        {
          "MetaClass": "List",
          "Method": "CustomPage",
          "EventStage": "EventPipeLineStage.PostMainOperationInsideTranasaction",
          "TypeName": "Mediachase.Commerce.Customization.Plugins.CustomPageNormalizationPlugin, Mediachase.Commerce"
        }
      ]
    },
    "MetaObjectOptions": {
      "MaxListObject": 1000,
      "UseCache": false,
      "CacheItemExpiration": 30,
      "UseSPOptimization": false,
      "SPItemExpiration": 10080,
      "Instances": [
        {
          "MetaClass": "",
          "Type": "Mediachase.BusinessFoundation.Data.Meta.MetaObject, Mediachase.BusinessFoundation.Data"
        }
      ],
      "Types": [
        {
          "Name": "Name",
          "Installer": "Mediachase.BusinessFoundation.Data.Meta.Management.DefaultMetaFieldInstaller, Mediachase.BusinessFoundation.Data",
          "Binder": "Mediachase.BusinessFoundation.Data.Meta.DefaultMetaObjectPropertyBinder, Mediachase.BusinessFoundation.Data"
        }
      ]
    },
    "SearchOptions": {
      "DefaultSearchProvider": "LuceneSearchProvider",
      "MaxHitsForSearchResults": 1000,
      "IndexerBasePath": "[appDataPath]/Foundation/SearchIndex",
      "IndexerConnectionString": "",
      "SearchProviders": [
        {
          "Name": "LuceneSearchProvider",
          "Type": "Mediachase.Search.Providers.Lucene.LuceneSearchProvider, Mediachase.Search.LuceneSearchProvider",
          "Parameters": {
            "queryBuilderType": "Mediachase.Search.Providers.Lucene.LuceneSearchQueryBuilder, Mediachase.Search.LuceneSearchProvider",
            "storage": "[appDataPath]/SearchIndex",
            "simulateFaceting": "true"
          }
        }
      ],
      "Indexers": [
        {
          "Name": "catalog",
          "Type": "Mediachase.Search.Extensions.Indexers.CatalogIndexBuilder, Mediachase.Search.Extensions"
        }
      ]
    },
    "CatalogOptions": {
      "AutoConfigure": true,
      "SalePriceTypes": [
        {
          "Key": "Subscription",
          "Value": "3",
          "Description": "Subscription"
        },
        {
          "Key": "MSRP",
          "Value": "4",
          "Description": "MSRP"
        }
      ],
      "ShowVariationListPrice": false,
      "CatalogImportBatchSize": 200,
      "CommandTimeout": -1,
      "CatalogEventLevel": 0,
      "DisableCatalogEventDrivenIndexing": false,
      "DisableQueueForIncrementalIndexing": false,
      "SkipCatalogContentModelCheck": false,
      "IgnorePropertyAndMetafieldMisMatch": false,
      "SimplifiedCatalogListingThreshold": 2000,
      "DraftMigrationBatchSize": 5000,
      "DraftMigrationTimeSpan": 1,
      "EnableFeatureGetReferencesInCatalog": false,
      "EnsurePublishedVersionInAllLanguages": true,
      "ArchivedThreshold": 30
    },
    "OptiGPTOptions": {
      "OptiAIKey": "",
      "OptiAISecret": "",
      "OptiAIUrl": "",
      "OptiAIDefaultModel": ""
    },
    "ApplicationOptions": {
      "DefaultApplicationName": "ECApplication",
      "AdminHomePage": "Dashboard",
      "Cache": {
        "Enabled": true
      },
      "AutoMigrate": true,
      "Features": {
        "DynamicPackageFeature": {
          "Feature": "DynamicPackageFeature",
          "State": 0,
          "Type": "Mediachase.Commerce.Core.Features.DynamicPackageFeature, Mediachase.Commerce"
        }
      }
    },
    "CustomerOptions": {
      "AutoInstall": true,
      "DemoInstall": true
    },
    "MarketingOptions": {
      "LinkableTypesEnabled": false
    },
    "OrderOptions": {
      "NewOrderStatus": "InProgress",
      "SensitiveDataMode": 1,
      "AutoConfigure": true,
      "DisableOrderDataLocalization": false,
      "WishListCartNames": [
        "WishList"
      ],
      "ExpiredCartsRemovalJobExcludedCartName": [
        ""
      ],
      "ExpiredCartJobDays": 30,
      "CommandTimeout": 30
    },
    "PermissionOptions": {
      "Enable": false
    },
    "DataOptions": {
      "DisableRetryPolicy": false,
      "LowFragmentationThreshold": 10,
      "HighFragmentationThreshold": 30,
      "DataBaseIndicesJobCommandTimeOut": -1,
      "LongQueryExecutionTimeOut": 10080,
      "UseBinaryFormatter": true
    },
    "MetaDataOptions": {
      "DisableVersionSync": false
    }
  }
}
```

--------------------------------

### Get validator properties response

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example response from the get_validator_properties tool. Shows a status code of 200, a message indicating 3 properties with validators, and a list of property paths.

```json
{
  "StatusCode": 200,
  "Message": "Found 3 properties with validators",
  "Properties": [
    "Condition_RequiredQuantity",
    "Reward_NumberOfFreeItems",
    "Discount_Items"
  ]
}
```

--------------------------------

### Get a MetaClass collection and write names to trace

Source: https://docs.optimizely.com/commerce-connect-14/docs/metaclass-class

Retrieves the MetaClassManager from DataContext.Current.MetaModel and iterates over the MetaClasses collection, writing each meta-class name to the trace output. This example writes only user tables.

```csharp
// Get MetaModel
    MetaClassManager metaModel = DataContext.Current.MetaModel;
    // Step 3. Enum meta-classes
    foreach (MetaClass mc in metaModel.MetaClasses)
      {
        Trace.WriteLine(mc.Name);
      }
```

--------------------------------

### Create and update a warehouse with IWarehouseRepository.Save()

Source: https://docs.optimizely.com/commerce-connect-14/docs/warehouses-and-inventories-examples

Shows how to create a new warehouse and update an existing one. The IWarehouse object from Get/List is read-only; you must create a writable clone before updating.

```csharp
public void CreateNewWarehouse()
  {
    var warehouseRepository = ServiceLocator.Current.GetInstance<IWarehouseRepository>();
    var warehouse = new Warehouse
      {
        Code = "NY",
        Name = "New York store",
        IsActive = true,
        IsPrimary = false,
        IsFulfillmentCenter = false,
        IsPickupLocation = true,
        IsDeliveryLocation = true,
        ContactInformation = new WarehouseContactInformation
          {
            FirstName = "First Name",
            LastName = "Last Name",
            Line1 = "Address Line 1",
            Line2 = "Address Line 2",
            City = "City",
            State = "State",
            CountryCode = "Country Code",
            PostalCode = "Postal Code",
            RegionCode = "Region Code",
            DaytimePhoneNumber = "Daytime Phone Number",
            EveningPhoneNumber = "Evening Phone Number",
            FaxNumber = "Fax Number",
            Email = "Email"
          }
      };
    warehouseRepository.Save(warehouse);
  }
    
public void UpdateWarehouse(string warehouseCode)
  {
    var warehouseRepository = ServiceLocator.Current.GetInstance<IWarehouseRepository>();
    var warehouse = warehouseRepository.Get(warehouseCode); // It's a read-only object
    var writableCloneWarehouse = new Warehouse(warehouse); // create writable clone before updating
    writableCloneWarehouse.IsPickupLocation = true;
    warehouseRepository.Service.Save(writableCloneWarehouse);
  }
```

--------------------------------

### Define a product variant content type with CatalogContentType

Source: https://docs.optimizely.com/commerce-connect-14/docs/commerce-rendering-templates

Example of a simple content type for a product variant implementing IContent. It uses the CatalogContentType attribute with a GUID and MetaClassName, and inherits from VariationContent.

```csharp
using System;
    using System.ComponentModel.DataAnnotations;
    using EPiServer.Commerce.Catalog.ContentTypes;
    using EPiServer.Commerce.Catalog.DataAnnotations;
    using EPiServer.Core;
    using EPiServer.DataAbstraction;
    using EPiServer.DataAnnotations;
    using EPiServer.SpecializedProperties;
    
    namespace MyCommerceSite.Models.Catalog
      {
        [CatalogContentType(GUID = "8d664789-3e96-409e-b418-baf807241f7c", MetaClassName = "My_Variation")]
        public class MyVariation : VariationContent
          {
          }
      }
```

--------------------------------

### Install Optimizely.Commerce.Opal.Tools NuGet package

Source: https://docs.optimizely.com/commerce-connect-14/docs/get-started-with-optimizely-agent-platform-tools

Use this command to add the Optimizely.Commerce.Opal.Tools package to your project. Requires .NET 8.0 or later and EPiServer.Commerce.Core 14.x.

```bash
dotnet add package Optimizely.Commerce.Opal.Tools
```

--------------------------------

### List promotions by sales response

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example response from the promotion_list_by_sales tool. Shows an items array with promotion details such as name, GUID, order count, discount type, and coupon code.

```json
{
  "items": [
    {
      "PromotionName": "20% Off Everything",
      "PromotionGuid": "abc123...",
      "OrderPlaced": 1250,
      "DiscountType": "Percentage",
      "CouponCode": "SAVE20"
    }
  ]
}
```

--------------------------------

### Retrieving shipping method ID

Source: https://docs.optimizely.com/commerce-connect-14/docs/shipping-gateways-and-providers

Example code to retrieve the shipping method details using the methodId passed into GetRate. It looks up the shipping method and gets its name, handling the case where the row is not found.

```csharp
// Look up payment method
    ShippingMethodDto methods = ShippingManager.GetShippingMethods(Thread.CurrentThread.CurrentCulture.Name); 
    // the methodId was passed into the method as one of the method parameters
    ShippingMethodDto.ShippingMethodRow row = methods.ShippingMethod.FindByShippingMethodId(methodId);
    
    string name; 
    if (row != null) 
      { 
       name = row.Name; 
      } 
    else 
      { 
       name = ""; 
      }
```

--------------------------------

### campaign_create example request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example JSON request for the campaign_create tool, which creates a marketing campaign. The request requires Name, ValidFrom, and ValidUntil, with an optional Description. Note: this tool returns a confirmation dialog before creating the campaign.

```json
{
  "Name": "Black Friday 2024",
  "Description": "Annual Black Friday sale event",
  "ValidFrom": "2024-11-29T00:00:00Z",
  "ValidUntil": "2024-12-02T23:59:59Z"
}
```

--------------------------------

### Get promotion properties request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example request body for the promotion_properties tool. Requires PromotionType (type name or full type name). Returns a response with status code, message, and a list of properties.

```json
{
  "PromotionType": "BuyQuantityGetItemDiscount"
}
```

--------------------------------

### Create Optimizely Commerce project with dotnet CLI

Source: https://docs.optimizely.com/commerce-connect-14/docs/creating-your-project

Run these commands in order to create a new Optimizely Customized Commerce project, set up the CMS and commerce databases, and add an admin user. Replace ProjectName, username, password, and email with your own values. The -S and -E flags specify the SQL Server and use Windows authentication, and --reuse-cms-user reuses the CMS user for the commerce database.

```csharp
dotnet new epi-commerce-empty --name ProjectName
cd projectname
dotnet-episerver create-cms-database ProjectName.csproj -S . -E
dotnet-episerver create-commerce-database ProjectName.csproj -S . -E --reuse-cms-user
dotnet-episerver add-admin-user ProjectName.csproj -u username -p password -e [email protected] -c EcfSqlConnection
```

--------------------------------

### GetAssetUrl method example

Source: https://docs.optimizely.com/commerce-connect-14/docs/asset-url-resolver

Shows how to use AssetUrlResolver.GetAssetUrl to get the default asset for a variation. It creates a media file, adds it as a CommerceMedia to a variation, and returns the asset URL. Requires setting up the necessary services and content types.

```csharp
using System.Globalization;
    using EPiServer;
    using EPiServer.Commerce.Catalog;
    using EPiServer.Commerce.Catalog.ContentTypes;
    using EPiServer.Commerce.SpecializedProperties;
    using EPiServer.Core;
    using EPiServer.DataAbstraction;
    using EPiServer.DataAccess;
    using EPiServer.Security;
    using EPiServer.Web;
    using Mediachase.Commerce.Catalog;
    
    public class UrlResolverSample
    {
        private AssetUrlResolver assetUrlResolver;
        private ReferenceConverter referenceConverter;
        private IContentLoader contentLoader;
        private AssetUrlConventions assetUrlConventions;
        private IContentRepository contentRepository;
        private ContentMediaResolver mediaDataResolver;
        private ContentTypeRepository contentTypeRepository;
    
        public string GetAssetUrl()
        {
            ContentReference rootCatalogLink;
            //Get a suitable MediaData type from extension
              var mediaType = mediaDataResolver.GetFirstMatching("jpg");
              var contentType = contentTypeRepository.Load(mediaType);
            //Get a new empty file data
              var media = contentRepository.GetDefault<IContentMedia>(SiteDefinition.Current.GlobalAssetsRoot, contentType.ID);
              media.Name = "MyImages";
              var contentLink = contentRepository.Save(media, SaveAction.Publish, AccessLevel.NoAccess);
            // Add variation
              var variation = contentRepository.GetDefault<VariationContent>(rootCatalogLink, CultureInfo.GetCultureInfo("en-US"));
              variation.Name = "Variation name";
              contentRepository.Save(variation, SaveAction.Save, AccessLevel.NoAccess);
              var commerceMedia = new CommerceMedia() {AssetLink = contentLink};
              variation.CommerceMediaCollection.Add(commerceMedia);
    
            return assetUrlResolver.GetAssetUrl<IContentImage>(variation);
        }
    }
```

--------------------------------

### Retrieve package information for a shipping provider using ShippingMethodDto

Source: https://docs.optimizely.com/commerce-connect-14/docs/shipping-gateways-and-providers

This example shows how to retrieve package information for a shipping provider using ShippingMethodDto. It iterates through shipping options, gets associated packages, and retrieves individual package details.

```csharp
Mediachase.Commerce.Orders.Dto.ShippingMethodDto shippingMethods =
      Mediachase.Commerce.Orders.Managers.ShippingManager.GetShippingMethods("en-us");
    
    foreach(System.Data.DataRow row in shippingMethods.ShippingOption.Rows)
      {
        // A shipping option is a shipping provider
        Mediachase.Commerce.Orders.Dto.ShippingMethodDto.ShippingOptionRow shippingProviderRow =
          (Mediachase.Commerce.Orders.Dto.ShippingMethodDto.ShippingOptionRow)row;
    
        // now you have access to packages associated with the shipping provider
        Mediachase.Commerce.Orders.Dto.ShippingMethodDto.ShippingPackageRow[] packageRows =
          shippingProviderRow.GetShippingPackageRows();
    
        //now you have access to the packages' names and id's
        //packageRows[0].ShippingPackageId
        //packageRows[0].PackageName
    
        //now you can retrieve the individual Package row with additional information
        Mediachase.Commerce.Orders.Dto.ShippingMethodDto method =Mediachase.Commerce.Orders.Managers.ShippingManager.GetShippingPackage(packageRows[0].PackageId);
    
        //the GetShippingPackage method just populates the Package table with the applicable shipping package
        if (method.Package.Rows.Count > 0)
          {
            Mediachase.Commerce.Orders.Dto.ShippingMethodDto.PackageRow packageRow =
              (Mediachase.Commerce.Orders.Dto.ShippingMethodDto.PackageRow)method.Package.Rows[0];
    
            //here we can retrieve the package properties
            //packageRow.Length
            //packageRow.Height
            //packageRow.Width
            //packageRow.Description
        }
      }
```

--------------------------------

### Install Optimizely templates with dotnet new

Source: https://docs.optimizely.com/commerce-connect-14/docs/setting-up-your-development-environment

Use this command to install the EPiServer.Templates package, which provides the necessary templates for creating Optimizely Customized Commerce projects. Requires .NET 6.

```javascript
dotnet new -i EPiServer.Templates
```

--------------------------------

### Configure ODPJob through configuration file (Before 14.20.0)

Source: https://docs.optimizely.com/commerce-connect-14/docs/commerce-connect-14-odp

JSON configuration file sample for configuring the ODP integration before version 14.20.0. Uses MarketKeys with MarketId, AccessKey, and EndpointUrl.

```json
{  
  "EPiServer" : {  
    "Commerce" : {  
       "ODPJob": {  
        "MarketKeys": [  
          {  
            "MarketId": "US",  
            "AccessKey": "key",  
            "EndpointUrl": "https://api.zaius.com/"  
          }  
        ]  
      }  
    }  
  }  
}
```

--------------------------------

### Retrieve and save catalog data using DTOs

Source: https://docs.optimizely.com/commerce-connect-14/docs/low-level-apis

Shows how to use CatalogContext.Current to get a CatalogDto, find an existing catalog ID, create a new catalog entry row, and save it. The example demonstrates the pattern of working with DTOs for saving catalog data.

```csharp
ICatalogSystem target = CatalogContext.Current;
    CatalogDto catalogs = target.GetCatalogDto();
    foreach (CatalogDto.CatalogRow catalog in catalogs.Catalog)
      {
        existingCatalogId = catalog.CatalogId;
        break;
      }
    
    CatalogEntryDto dto = target.GetCatalogEntriesDto(existingCatalogId, response);
    // Catalog entry create and set properties
    CatalogEntryDto.CatalogEntryRow catalogEntryRow = dto.CatalogEntry.NewCatalogEntryRow();
    catalogEntryRow.ApplicationId = CatalogConfiguration.Instance.ApplicationId;
    dto.CatalogEntry.AddCatalogEntryRow(catalogEntryRow);
    target.SaveCatalogEntry(dto);
```

--------------------------------

### Create a new record with CustomTableRow

Source: https://docs.optimizely.com/commerce-connect-14/docs/working-with-sql-records

Creates a new CustomTableRow object, sets column values using the index property, and calls Update to confirm the addition. Use PrimaryKeyId to get the primary key. BF supports Integer and Guid as primary keys.

```csharp
// Create a new book
CustomTableRow newBook = CustomTableRow(bookTable);
newBook["Title"] = "Programming Windows Phone 7";
newBook.Update();
PrimaryKeyId newBookPk = newBook.PrimaryKeyId.Value;
```

--------------------------------

### Render alternative and cross-sell recommendations in Package view

Source: https://docs.optimizely.com/commerce-connect-14/docs/server-side-api-integration

Add these sections to the Package view to render alternative products in RightMarginRecommendations and cross-sell products in BottomRecommendations.

```csharp
@section RightMarginRecommendations
{
    @{
        Html.RenderAction("Index", "Recommendations", new
        {
            recommendations = Model.AlternativeProducts
        });
    }
}
@section BottomRecommendations
{
    @{
        Html.RenderAction("Index", "Recommendations", new
        {
            recommendations = Model.CrossSellProducts
        });
    }
}
```

--------------------------------

### Get promotion properties response

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example response from the promotion_properties tool for the BuyQuantityGetItemDiscount promotion type. Shows a status code of 200, a message indicating 15 properties found, and a list of property objects with details such as name, property path, type, display name, description, required flag, and constraints.

```json
{
  "StatusCode": 200,
  "Message": "Found 15 properties",
  "PromotionType": "BuyQuantityGetItemDiscount",
  "Properties": [
    {
      "Name": "RequiredQuantity",
      "PropertyPath": "Condition_RequiredQuantity",
      "PropertyType": "Int32",
      "DisplayName": "Required Quantity",
      "Description": "Number of items required to trigger promotion",
      "IsRequired": true,
      "MinValue": 1,
      "DefaultValue": 1
    },
    {
      "Name": "Percentage",
      "PropertyPath": "Discount_Percentage",
      "PropertyType": "Decimal",
      "DisplayName": "Discount Percentage",
      "Description": "Percentage discount to apply",
      "IsRequired": true,
      "MinValue": 0,
      "MaxValue": 100
    }
  ]
}
```

--------------------------------

### commerce_list_market example request

Source: https://docs.optimizely.com/commerce-connect-14/docs/available-tools

Example JSON request for the commerce_list_market tool, filtering by IsEnabledOnly and Currency.

```json
{
  "IsEnabledOnly": true,
  "Currency": "USD"
}
```

--------------------------------

### Get promotions and items for campaign

Source: https://docs.optimizely.com/commerce-connect-14/docs/promotions-engine

Gets a list of promotion items for a given campaign link.

```csharp
IEnumerable<PromotionsItems> promotionItemsList = ServiceLocator.Current.GetInstance<IPromotionEngine>().GetPromotionItemsForCampaign(campaignLink);
```

--------------------------------

### Get promotion details

Source: https://docs.optimizely.com/commerce-connect-14/docs/common-workflows

Gets promotion details using the promotion_detail tool, including additional details.

```json
Tool: promotion_detail
{ "Identifier": "456", "IncludeAdditionalDetails": true }
```

--------------------------------

### appsettings.json configuration for LowestPriceOptions

Source: https://docs.optimizely.com/commerce-connect-14/docs/lowest-price-in-a-period-of-time

JSON configuration to set the DaysAgo value for the lowest price tracking period.

```json
"Commerce": {
  "LowestPriceOptions": {
    "DaysAgo": 30
  },
}
```

--------------------------------

### Register custom meta type installer and binder in appsettings.json (Commerce 14)

Source: https://docs.optimizely.com/commerce-connect-14/docs/metatype-class

For Commerce 14, register the custom meta-field installer and meta-object property binder in the 'Commerce' section of appsettings.json under 'MetaObjectTypeOptions'. Replace 'CustomType', 'Installer', and 'Binder' with your actual values.

```json
"Commerce":{      
    "MetaObjectTypeOptions": {
            "Types": [
              {
                "Name": "CustomType",
                "Installer": "",
                "Binder": ""
              }
            ]
          }
    }
```
Tokens:
Raw