Custom Store Provider

Use this feature to customize various aspects of the Storefront module, such as payment processing, adding shipping costs, integration with CRM and more. The system provides StorefrontStandardProvider which implements out-of-the-box features such as reading the store product data from the system's products and collections and does the order processing with supporting merchants such as PayPal Express, Authorize.NET or Stripe.

To customize, you need to create an Active Class which is derived from StorefrontStandardProvider and can override certain functionalities as documented below:

public class MyStorefrontProvider: StorefrontStandardProvider
{
    // override the methods that you need.
}

The following is the list of methods that you may want to override depending on what your requirements are:

CreateShoppingCart()

Use this method to populate the shopping cart defaults and details. This method returns a ShoppingCartInfo object that contains the current user's information, including their mailing address, shipping address, and more. This method is used when the storefront is loaded and/or whenever it needs to access the shopping card information.
 

CalculateOrder(ShoppingCartInfo info, ShoppingCart cart)

Use this method to add shipping costs, adjust taxes, and apply discount codes or other variables to the shopping cart. All such changes will be applied to the ShoppingCartInfo object passed to the method. 

ProcessOrder(ShoppingCartInfo info, ShoppingCart cart)

Use this method to perform tasks pre- or post-transaction. This method is called when the user clicks on "Checkout". If the payment is processed, the ShoppingCartInfo.OrderNumber will be populated. 

Let's say we want to integrate EasyPost or ShipEngine with Magentrix so that you can calculate shipping costs and populate the information.  

public class MyStorefrontProvider: StorefrontStandardProvider
{
    public override ShoppingCartInfo CalculateOrder(ShoppingCartInfo info, ShoppingCart cart)
    {
        var cartInfo = base.CalculateOrder(info, cart);
        
        // Calculate shipping costs (Assumes a class EasyPost has the implementation)
        EasyPost.GetShippingCosts(cartInfo);
        
        return cartInfo;
    }
}

The following code provides guidelines on how to get storefront order information after an order is processed to save the results into an external system such as a CRM.

public class MyStorefrontProvider: StorefrontStandardProvider 
{ 
    public override ShoppingCartInfo ProcessOrder(ShoppingCartInfo info, ShoppingCart cart)
    { 
       var cartInfo = base.ProcessOrder(info, cart);

       // Check to see if the order was processed successfully
       if (!string.IsNullOrEmpty(cartInfo.OrderNumber))
       {
           // Using the ShoppingCartInfo, you may create an "Close/Won" Opportunity
           var oppId = MyCrmOrderHelper.CreateOpportunity(info);

           // Using the cart information, you may create Opportunity line items
           MyCrmOrderHelper.CreateOppLineItems(oppId, cart);
       }
    }
}

ShoppingCartInfo

ShoppingCart

This class has a list of shopping items which are the products that are added to the cart.

ShoppingCartItem

ShoppingProduct refers to the Storefront Product entity in Magentrix platform.
ShoppingProductOption refers to the Storefront Product Variation which is selected by the user. If the product does not have any variations, this property will be null.