Markets

This topic describes the Market concept, which is central to Optimizely Commerce. A single site can have multiple markets, each with its own product catalog, language, currency, and promotions.

Classes in this topic are available in the Mediachase.Commerce or Mediachase.Commerce.Markets namespaces.

CurrentMarket interface

Sites that implement multi-market functionality must also implement the ICurrentMarket interface. The ICurrentMarket implementation must return the market of the current request, and is called to get the appropriate market for the execution of most market-sensitive business logic.

[Commerce 14] You register custom ICurrentMarket implementations in ConfigureServices method of the Startup class.

A business's market segmentation strategy determines its implementation of the ICurrentMarket interface. If your business segments markets geographically, you may want to use a prestitial page, an IP geolocation service, or a simple drop-down control to determine a user's region and market.

Markets are not constrained to a region; a business-to-business is likely to permit only authenticated users to use the system, and may assign a market to each customer when the customer is created. In this case, the ICurrentMarket implementation's retrieval of the current market is based on the current authenticated user.

The default, supplied implementation of ICurrentMarket always returns the default market. This is the correct behavior for sites that do not implement multi-market functionality.

[Commerce 14 and higher] The ICurrentMarket interface.

public interface ICurrentMarket
  {
    // Gets the current market.
    IMarket GetCurrentMarket();

    // Sets the current market.
    void SetCurrentMarket(MarketId marketId);
  }

using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.Framework.ServiceLocation;
using Mediachase.Commerce;

// The custom implementation of ICurrentMarket
public class MyCurrentMarketImplementation : ICurrentMarket
  {
    public IMarket GetCurrentMarket()
      {
        ... implementation ...
      }

    public void SetCurrentMarket(MarketId marketId)
      {
        ... implementation ...
      }
  }


public class Startup
{
  public void ConfigureServices(IServiceCollection services)
  {
    services.AddSingleton<ICurrentMarket, MyCurrentMarketImplementation>();
  }
}

public interface IMarket
  {
    // Gets the market's unique identifier.
    MarketId MarketId { get; }

    // Gets a value indicating if the the market is enabled.
    bool IsEnabled { get; }

    // Gets the market's name.
    string MarketName { get; }

    // Gets the market's description.
    string MarketDescription { get; }

    // Gets the default language for the market.
    CultureInfo DefaultLanguage { get; }

    // Gets the available languages for the market.
    IEnumerable<CultureInfo> Languages { get; }

    // Gets the default currency for the market.
    Currency DefaultCurrency { get; }

    // Gets the available currencies for the market.
    IEnumerable<Currency> Currencies { get; }

    // Gets the countries associated with the market.
    IEnumerable<string> Countries { get; }

    // Gets the value indicating if the price of the market includes tax or not.
    bool PricesIncludeTax { get; }
  }

public interface IMarketService
  {
    // Gets all markets in the system.
    IEnumerable<IMarket> GetAllMarkets();

    // Get a single market by ID, or null if the market ID is not found.
    IMarket GetMarket(MarketId marketId);

    // Adds a new market to the market system.
    void CreateMarket(IMarket market);

    // Updates an existing market in the market system.
    void UpdateMarket(IMarket market);

    // Deletes a market by ID.
    void DeleteMarket(MarketId marketId);
  }