In this article, we highlight the expected pricing outcomes through decision tables.
For a high-level look at the important aspects of the business logic that determine list and sell prices, see Pricing Calculation Logic – Part 1.
Pricing Transparency (Advanced)
The following decision tables can be utilised to help understand and troubleshoot pricing outcomes.
Important notes:
The business logic applies to the OOTB Sitecore Commerce solution.
Price cards are resolved by the price book associated to the catalog.
These findings do not take into consideration promotions, specifically those that affect sellable item/variant sell price.
Sellable Item Price Calculation
These messages will be applied to the MessagesComponent of a SellableItem entity.
In simplying the table, I took a few shortcuts to note:
‘Valid snapshot’ conditions assume a price card has been resolved by name or tag. Refer to the previous flow diagrams in Pricing Calculation Logic – Part 1 to understand the more complex conditions.
For ‘Has variants?’, ‘Calculate item list price in depth?’, and ‘Has list price for currency?’ conditions, the Rules that state a group ‘N’. However, I actually mean that some, but not all, of these conditions can be true.
Variant Price Calculation
These messages will be applied to the MessagesComponent of a ItemVariationComponent within the SellableItem entity.
In simplying the table, I took a few shortcuts to note:
‘Valid snapshot’ conditions assume a price card has been resolved by name or tag. Refer to the previous flow diagrams in Pricing Calculation Logic – Part 1 to understand the more complex conditions.
Cart Item Calculation (Sellable Item)
These messages will be applied to the MessagesComponent of a sellable item CartLineComponent.
Messages will be applied in the following order:
Sellable Item Price Calculation
Cart Item Calculation (Sellable Item)
Cart Item Calculation (Variant)
These messages will be applied to the MessagesComponent of a variant CartLineComponent.
In this multi-part article, we will review the Sellable Item/Variant price calculation processes that determines and differentiates the list pricing from the sell pricing.
As this is one of the more complex areas of Sitecore Commerce, Part 1 will cover the business logic used to apply the pricing, while Pricing Calculation Logic – Part 2 will highlight the expected pricing outcomes through decision tables.
This article is intended to suplement the official Pricing transparency documentation.
Introduction
The MessagesComponent on the SellableItem entity, ItemVariationComponent, and CartProductComponent provides the audit trail for how the sellable item/variant pricing was calculated. The ‘<=‘ in the Text property is not a logic operator, but instead represents the assignment of the source to the price type.
The 2 primary pricing scenarios we see in Sitecore Commerce are:
The pricing of a sellable item/variant as is (per single unit)
The pricing of a sellable item/variant once added to the cart. Pricing calculations here may also affected by quantity, via price tiers of associated price cards, and specific promotions that affect the sell price.
Sellable Item/Variant Pricing Calculations
The first scenario, where we are retrieving a sellable item/variant, to display on the Product Listing or Product Details pages for example, calculates the pricing through the following steps:
Calculate Sellable Item Sell Price
Calculate Variations Sell Price
Calculate Sellable Item List Price
Calculate Variations List Price
Reconcile Sellable Item Prices
Important notes:
The business logic applies to the OOTB Sitecore Commerce solution.
Price cards are resolved by the price book associated to the catalog.
These findings do not take into consideration promotions, specifically those that affect sellable item/variant sell price.
Calculate Sellable Item Sell Price
The CalculateSellableItemSellPriceBlock will attempt to determine the sell price for the sellable item, adding it to the PurchaseOptionMoneyPolicy.
Notable flow aspects
Only the first attempt at resolving a price card will be utilised. i.e. if the price card name associated to the sellable item cannot be resolved to a price card or valid snapshot, the price card by tags logic is not used as a fall back.
Calculate Variations Sell Price
The CalculateVariationsSellPriceBlock will attempt to determine the sell price for each variant of the sellable item.
Notable flow aspects
The flow diagram represents a single variant. The pipeline block will utilise this flow for each variant.
Only the first attempt at resolving a price card will be utilised.
If the price card is resolved from the sellable item, the message will not reflect that the price card was retrieved from the sellable item.
Calculate Sellable Item List Price
The CalculateSellableItemListPriceBlock will attempt to determine the list price for sellable item.
Notable flow aspects
The GlobalPricingPolicy‘s CalculateItemListPriceInDepth property is set to false by default.
When iterating over variants for a valid ListPricingPolicy, the first variant to have a valid ListPricingPolicy will be used. The logic does not look for the lowest or highest price amongst all variants.
Calculate Variations List Price
The CalculateVariationsListPriceBlock will attempt to determine the list price for each variant of the sellable item.
Reconcile Sellable Item Prices
The ReconcileSellableItemPricesBlock will attempt to resolve missing List Prices and Sell Prices from the sellable item and variants. A flow diagram has been created for the Sellable Item and Variants separately.
Notable flow aspects
Setting the list price to 0 will ensure a price has been assigned.
Notable flow aspects
Setting the list price to 0 will ensure a price has been assigned.
Cart Line Calculations
The second scenario mentioned was that where the pricing calculation of sellable items/variants that have been added to the cart. The following step is performed after the standard pricing calculations to take into consideration the price tiers from price cards:
Calculate Cart Line Price
Calculate Cart Line Price
The CalculateCartLinePricesBlockwill determine and apply the appropriate list and sell prices for each cart line.
Notable flow aspects
There is an expectation that the list price and sell prices would have been resolved in Reconcile Sellable Item Prices.
Where a snapshot exists on a sellable item/variant the cart line’s quantity value will determine the price tier that will be utilised to retrieve the sell price from.
The messages from the Sellable Item and, if applicable, Variant are copied into the cart line MessagesComponent to document the pricing stacks, which assist in auditing pricing overrides in determining the final pricing.
Glossary
Navigating the pricing logic can be time-consuming due to similar and varied terms being used for similar or varying components, so here is a short glossary for better clarification.
Sellable Item/Variant List Pricing (Policy): The list pricing policy represents an array of prices (only one price per currency) that are associated to a sellable item/variant is specified under the Pricingentity view of the sellable item/variant in the Merchandingmanager.
Price Card (Name): The price card or price card name associated to the sellable item/variant is specified under the Pricingentity view of the sellable item/variant in the Merchandingmanager.
Sellable Item/Variant list price: This is the ListPriceproperty of a Sellable Item/Variant, not to be confused with the ListPricingPolicy.
In this article, we will review the default business logic that the Commerce Engine utilises to evaluate and apply promotions.
Note: References to date will indicate both date and time throughout this article.
Introduction
Before we get into the details around promotions, there are a few things we need to understand.
Promotions are separated into cart line level and cart level promotions, determined by the promotion benefits configured to each promotion. While multiple benefits can be added to promotions, additional benefits after the first can only be of the same benefit type.
Cart line calculations (subtotals, fulfillment fees, promotion discounts, taxes, totals) are evaluated and applied prior to the and cart calculations.
Exclusive promotions apply against the benefit type only, therefore it is possible to apply a cart line level exclusive promotion and a cart level exclusive promotion at the same time.
Evaluating Promotions
The following diagram shows the pipelines and pipeline blocks that are called during the process of evaluating the applicable promotions and additional filtering for exclusive promotion evaluation.
There are essentially 10 steps that make up the evaluation process:
Search For Promotions: Retrieves all promotions.
Filter Promotions By Valid Date: Removes promotions that do not fall within the Valid From/To dates based on effective date.
Filter Not Approved Promotions: Removes promotions that are not approved and, if the promotion is disabled, where the effective date is prior to the updated date (the date the promotion was disabled). The latter rule is to allow the promotion to be active when reviewed the storefront at a previous point in time.
Note: From 9.0.1, the GlobalPromotionsPolicy was introduced to allow promotions to be previewed in the storefront prior to submitting a promotion for approval.
Filter Promotions By Items: Removes promotions where the cart contains no sellable items marked as included in the ItemsCollection qualification or where the cart contains any of the sellable items marked as excluded in the ItemsCollection qualification.
Filter Promotions By Book Associated Catalogs: Removes promotions where the catalog, associated to its promotion book, does not match any of the catalogs associated to the sellable items of the cart lines.
Filter Promotions By Benefit Type: Removes promotions where the type of benefits configured to the promotion does not match the benefit type being evaluated. i.e. Cart line level benefits (CartLineActions) and cart level benefits (CartActions) for CalculateCartLinesPipeline and CalculateCartLinesPipeline respectively.
Filter Promotions By Coupon: Removes promotions that require a coupon that has not been applied to the cart.
Evaluate Promotions: Filters out promotions where promotion qualifications and benefit rules do are not applicable to the current cart.
Filter Promotions With Coupons By Exclusivity: If exclusive coupon promotions are present in the promotions list, the list will be filtered down to a single exclusive coupon promotion. The promotion will be determined by the Addeddate that their corresponding coupons were applied to the cart.
Filter Promotions By Exclusivity: If exclusive automatic promotions are present in the promotions list, the list will be filtered down to a single exclusive automatic promotion. The promotion will be determined by the earliest (oldest) Valid From date, and in the event of multiple promotions sharing the same earliest Valid From date the promotion that was created earliest will take win.
Promotion Priorisation Rules
While the previous section covered how promotions are evaluated, and also provided some insight into promotion priorisation, we will now cover the prioritisation rules.
The following diagram shows the logic used to determine which promotion(s) to apply to the cart.
There are essentially 3 steps that make up the application process:
Apply a single exclusive automaticpromotion.
The promotion will be determined by the earliest (oldest) Valid From date, and in the event of multiple promotions sharing the same earliest Valid From date the promotion that was created earliest will take win.
If a promotion is applied here no further promotions are applied.
Apply a single exclusive coupon promotion.
The promotion will be determined by the Addeddate that their corresponding coupons were applied to the cart.
If a promotion is applied here no further promotions are applied.
Apply all non-exclusive promotions.
The promotion order will be determined by:
Automatic promotions ordered by earliest (oldest) Valid From date, and in the event of multiple promotions sharing the same earliest Valid From date the promotion that was created earliest will take win.
Coupon Promotions ordered by earliest Addeddate that their corresponding coupons were applied to the cart.
In this article, we review another small plugin created, which exposes the variation properties in the Variants entity view within the Merchandising Manager.
The Habitat catalog data has been created in such a way in which the variation properties are exposed via adding the variation property value to the variant display name, e.g. Habitat Dwell Bagless Upright Vacuum (Red). While this approach works to an extent, it will get more ugly as the variation properties grow, e.g. My Test Jeans (Blue, 32, slim).
The custom plugin will traverse over the variation’s components to find the the properties that match the names provided in the VariationPropertiesPolicy and render them to the Variants entity view.
In the example above, I have specified the following property names, Color, Size, Style, and Length, which works well when all properties have been specified (see below).
A couple of things to note about the platform implementation:
Variation Properties apply to all Sellable Items globally. If a product contains a value against a property that is specified in the Variation Properties Policy it will render as a variant selection in the Storefront.
There is no validation to ensure that variation properties are mandatory for variants. This is because not all products will utilise these variation properties. I didn’t think it was necessary to add more overhead to remove columns that contained no values.
You’ll notice above that the first 2 variants of my Test Pants have matching variation properties. This is again due to having no validation in place, which I believe will break the storefront. So whether you have implemented a catalog import or are entering product data manually be careful not to double up.
In this article, we will review the process of configuring product variations properties so that the Product Variants SXA component will render them as dropdown selection controls. This controls allows the user to select the variant property combinations, where each combination represents individual product variants of a product family.
Configure the Variation Properties
In the Commerce Engine solution:
Define all variation property names in the VariationPropertyPolicy of the environment configuration files.
In this sample, we will add the Style property to the VariationPropertyPolicy. Note: The property names are the names of properties that exist on child components of the ItemVariationComponent. The fully qualified namespace for the property is not required as the SXA Storefront logic will use a property name match against the field names produced by the Catalog Generated templates.
Publish the solution and Bootstrap the Commerce Engine.
Verify the variation property in the Storefront. Note: In the sample below I updated the sellable item’s Style property with the value “Modern” for demo purposes.
Add Variant Specification Label
If you create add new properties that does not have corresponding label configured the variation property label will display as “[YourProperty]“.
To resolve this, go to the Sitecore Content Editor:
Add user friendly label value to /sitecore/Commerce/Commerce Control Panel/Storefront Settings/Commerce Terms/Variant Specification Labels.
In this article, we introduce a small custom plugin for Sitecore Commerce Business Tools that enables the reordering of images for sellable items and variants.
In its current release (XC 9.0.3), the only way to reorder images is to remove existing images and re-adding them in the desired order. It’s not the best user experience and can take a considerable length of time to relocate the original images.
The custom catalog plugin adds 2 new actions to the Images actions – Move Image Up and Move Image Down.
The functionality is still a little clunky. The confirmation dialog shows each time an image is moved, the selected image will always reset to the first image after each action, and while the move buttons are not disabled for its outer limits, the code logic prevents out of boundary exceptions from being thrown. Overall, it is definitely an upgraded approach to reordering images.
Publishing the sellable item through workflow is still required in order to have the changes show in the storefront.
In this article, we will look at how to manage catalog images that are associated to sellable items in the Business Tools‘ Merchandising Manager.
With the Habitat Master catalog and SXA Storefront site that is setup during the installation of Sitecore Experience Commerce, we have a great reference point for implementing custom sites. However, one of the not so obvious configurations is how to configure catalog images for new catalogs.
Commerce Media Items OData API Key
In Sitecore’s Coredatabase (pre XC 9.1) or Master database (from XC 9.1), the Commerce Media Items OData API Key contains the Search Filter property, which is responsible for applying the filter of media items that are restricted in the search results.
(Fields/any(f: (f/Name eq 'Extension' and (f/Value eq 'png' or f/Value eq 'jpg'))) and Language eq 'en' and (contains(Path, '/images/adventure') or contains(Path, '/images/habitat')))
The Search Filter value itself is performing 3 levels of filtering:-
Extension Type: The supported media extension types.
Language: The language is utilised to prevent duplicate media items from being returned, i.e. per language version.
Location: The media library folder where the catalog images are stored.
Note: This is a global configuration that will apply to all media search controls in Sitecore Commerce. This means that although we can segregate catalog images to different Media Library folders in Sitecore, the Image search results in the Business Tools will return results for all configured catalog image folder locations and extension types. This makes sense considering sellable items can be associated across catalogs.
Configuring Image Extension Types
The default configured image types include jpg and png formats. To modify the extension types, we look at the extension part of the filter where we can add or remove the Value comparisons as desired.
(f: (f/Name eq 'Extension' and (f/Value eq 'png' or f/Value eq 'jpg')))
Configure the Value comparison in the format f/Value eq ‘<extension type>’. Don’t modify the wrapping logic. When specifying multiple extensions use the ‘or’ clause as per the initial configuration.
Adding Extension Type Example
In this example, I will add the gif extension type and sample image to validate the change.
Configure the Extension Type
In the Sitecore Content Editor using the Core database (pre XC 9.1) or Master database (from XC 9.1) :-
Go to /sitecore/system/Settings/Services/API Keys/CommerceMediaItemsODataAPIKey
Update the extension part of the Search Filter value to include the ‘gif’ comparison.
(f: (f/Name eq 'Extension' and (f/Value eq 'png' or f/Value eq 'jpg' or f/Value eq 'gif')))
Add Images of the New Extension Type
In the Sitecore Content Editor using the Masterdatabase:-
Go to /sitecore/media library/Images/<catalog image folder>
Upload the media file to the folder. e.g. sunglasses.gif
Publish the item.
Re-index the master/web databases.
Add the Image to a Sellable Item
In the Business Tools’ Merchandising Manager:-
Navigation to the desired Sellable Item or create a new Sellable Item.
Ensure the Sellable Item‘s Entity Version has not been published, otherwise a new version will need to be created.
Under the Images section, click the Add an Image button.
Search for the image name.
Select the image name and click the tick (accept) button.
Promote the sellable item through the workflow states until it’s published.
View the Image on the Sellable Item in the Storefront
In the Storefront’s website:-
Either navigate to the Category or Search Results Page, containing the product, navigate to any page that contains any component that displays the Sellable Item, e.g. Promoted Products component, or navigate directly to the Product Details Page.
Configuring Image Source Location
For media image location, we need to configure the location part of the filter where we can add or remove the Path comparisons as desired.
By default, we see that the locations have been configured for the folders that have been utilised for the Adventure Works and Habitat catalogs.
(contains(Path, '/images/adventure') or contains(Path, '/images/habitat'))
Configure the Path to the location of the catalog images folder in the format contains(Path, ‘/<catalog image folder location>’) where <catalog image folder location> is under the Media Library Sitecore item tree. When using multiple folder locations (usually one folder per catalog), use the ‘or’ clause as per the initial configuration.
Update: I found that the contains function had some issues with parsing the Path value where spaces are used in the item names, hence ‘/images/adventure’ rather than ‘/images/adventure works’. Another issue I found was that using the contains function also meant that any folder structure, outside the Media Library item, in the Sitecore tree that matched the path would also be included for the media search results causing undesired entries.
To resolve this, I found a more performant an accurate solution using the startswith function, which appears to resolve the Path value relative to the Media Library item and accepts spaces in the item names.
(startswith(Path, '/images/adventure works/')
Please note that I haven’t updated the remainder of this article with this change, but keep it in mind when making updating the filter yourself.
Adding Catalog Image Folder Example
In this example, I will add the HelloWorld catalog image folder type and sample image to validate the change.
Configure the Location Folders
In the Sitecore Content Editor using the Coredatabase (pre XC 9.1) or Master database (from XC 9.1) :-
Go to /sitecore/system/Settings/Services/API Keys/CommerceMediaItemsODataAPIKey
Update the location part of the Search Filter value to include the ‘helloworld’ comparison.
(contains(Path, '/images/adventure') or contains(Path, '/images/habitat') or contains(Path, '/images/helloworld'))
Add Images of the Catalog Image Folder
In the Sitecore Content Editor using the Masterdatabase:-
Go to /sitecore/media library/Images/HelloWorld
Upload the media file to the folder. e.g. sunglasses.jpg
Publish the item.
Re-index the master/web databases.
Search for the Image in the Merchandising Manager
In the Business Tools’ Merchandising Manager:-
Navigation to the desired Sellable Item or create a new Sellable Item.
Ensure the Sellable Item‘s Entity Version has not been published, otherwise a new version will need to be created.
Under the Images section, click the Add an Image button.
Search for the image name.
Ensure the image shows in the search results
Summary
We learnt that the configurations of image folder location and filtered media extension types for catalog images are set in the Search Filter field of the Commerce Media Items OData API Key Sitecore item in the Coredatabase (pre XC 9.1) or Master database (from XC 9.1) . We also learnt that the configurations are global and will apply to all media search controls in the Business Tools.
Reading Time: < 1minuteTo speed up development with Commerce Engine customisations, I have created a library of templates for Visual Studio. This should remove the necessity of referencing the sample commerce engine plugin project or decompiling and cleaning code from certain DLLs just to get to a starting point for your customisations.
Throughout this article we will utilise the categoryComputers and Tablets > Kid’s Tablets and productMinnow Kid’s Tablet—7”, 8GB to review our progress. These examples also contain some non-alphanumeric characters to ensure we take these special characters into consideration.
How Storefront URLs are Generated
Storefront URLs are constructed using the configuration of the site’ s linkManager. The configuration is located at sitecore/linkManager/providers/add[@name=’commerce‘].
An important note about the provider configuration properties is that only 3 properties actually affect the generated URLs – includeFriendlyName, useShopLinks, and encodeNames.
includeFriendlyName: Includes the DisplayName of the category or product in the URL segment. i.e. {category DisplayName}={category FriendlyId}and {product DisplayName}={ProductId/FriendlyId}.
useShopLinks: Constructs URL with shop/{category}/{product} if enabled, otherwise as category/{category} and product/{product}for category and product URLs respectively.
includeCatalog:Not currently supported
addAspxExtension: N/A
alwaysIncludeServerUrl: N/A
encodeNames: Encodes the DisplayName portion of the category and product segments. Only supported when useShopLinks is true.
languageEmbedding: N/A
languageLocation: N/A
lowercaseUrls: Not currently supported
shortenUrls: Not currently supported
useDisplayName: Not currently supported
URLs Generated from Various Configurations
The following decision table shows the available configurations
Rules
Conditions
1
2
3
4
5
useShopLinks
Y
Y
Y
N
N
includeFriendlyName
Y
Y
N
Y
N
encodeNames
Y
N
Y
Actions
1
2
3
4
5
Shop
X
X
X
Product/Category
X
X
Display Name prefix
X
X
X
Display Name encoding
X
X
The following table shows the URLs generated from the rules in the above table.
The URLs generated are looking good. We do have an issue with the URLs still containing encoded spaces. To control character encoding there is a configuration in the content editor at /sitecore/Commerce/Commerce Control Panel/Storefront Settings/Global Configuration > URL Encoding > Catalog Item Encoding.
Unfortunately there is a quirk in which it doesn’t accept space entries, so we will override the EncodeUrlToken and DecodeUrlToken methods instead. As we aren’t allowed to have hyphens in the category names, we won’t have any character conflicts where encoding or decoding.
Now that we have our category URL structure that meets our requirements, our last step is to ensure the URLs are resolving back to their correct Sitecore items.
Updating the CatalogPageItemResolver
Now we have covered the URL generation implementation, we now need to resolve these URLs back to their correct Sitecore items.
public override void Process(PipelineArgs args)
{
if (Context.Item == null || SiteContext.CurrentCatalogItem != null)
{
return;
}
var contextItemType = GetContextItemType();
switch (contextItemType)
{
case ItemTypes.Category:
case ItemTypes.Product:
var isProduct = contextItemType == ItemTypes.Product;
var catalogItemIdFromUrl = GetCatalogItemIdFromUrl(isProduct);
if (string.IsNullOrEmpty(catalogItemIdFromUrl))
{
break;
}
var catalog = StorefrontContext.CurrentStorefront.Catalog;
var catalogItem = ResolveCatalogItem(catalogItemIdFromUrl, catalog, isProduct);
if (catalogItem == null && !isProduct)
{
catalogItemIdFromUrl = GetCatalogItemIdFromUrl(true);
if (string.IsNullOrEmpty(catalogItemIdFromUrl))
{
break;
}
catalogItem = ResolveCatalogItem(catalogItemIdFromUrl, catalog, isProduct);
}
if (catalogItem == null)
{
WebUtil.Redirect("~/");
}
SiteContext.CurrentCatalogItem = catalogItem;
break;
}
}
private string GetCatalogItemIdFromUrl(bool isProduct)
{
var catalogItemId = string.Empty;
var rawUrl = HttpContext.Current.Request.RawUrl;
var urlTokens = rawUrl.Split('/');
if (urlTokens.Any())
{
var item = urlTokens.Last();
var queryStringPosition = item.IndexOf("?", StringComparison.OrdinalIgnoreCase);
if (queryStringPosition > 0)
{
item = item.Substring(0, queryStringPosition);
}
if (isProduct && urlTokens.Length >= 4)
{
var parentCategoryName = urlTokens[urlTokens.Length - 2];
item = $"{parentCategoryName}{item}";
}
catalogItemId = CatalogUrlManager.ExtractItemId(item);
}
return catalogItemId;
}
Summary
We learnt that the construction of the URL can be managed via Sitecore Configuration, the Sitecore Content Editor and via code customisations, depending on the URL requirements.
In this article, we will cover the common naming conventions found within Sitecore Experience Commerce to maintain a consistent approach in our custom plugins.
CRUD Operations
Starting with some simple CRUD operations, the following tables documents the naming conventions to utilise for the various Commerce classes
Entities
Create Entity
Naming Convention: Add<entity><context>
Commerce Reference
Example
Controller Action
AddPriceBook (CommandsController)
Command
AddPriceBookCommand
Model
PriceBookAdded
Pipeline
AddPriceBookPipeline
Pipeline Argument
AddPriceBookArgument
Pipeline Block
AddPriceBookBlock
Read Entity
Naming Convention: Get<entity><context>
Commerce Reference
Example
Controller Action
Get (<Entity>Controller)
Command
N/A. Use FindEntityCommand instead
Model
FoundEntity (handled within FindEntityCommand)
Pipeline
IFindEntityPipeline (handled within FindEntityCommand)
Pipeline Argument
FindEntityArgument (handled within FindEntityCommand)
Pipeline Block
SQL.FindEntityBlock (handled within FindEntityCommand)
Update Entity
Naming Convention: Update<entity><context>
Commerce Reference
Example
Controller Action
EditPriceBook (CommandsController)
Command
EditPriceBookCommand
Model
PriceBookEdited (No current usages)
Pipeline
EditPriceBookPipeline
Pipeline Argument
EditPriceBookArgument
Pipeline Block
EditPriceBookBlock
Delete Entity
Naming Convention: Delete<entity><context>
Commerce Reference
Example
Controller Action
DeletePriceCard. (CommandsController)
Note: When deleting entities, it is important to consider how references to these entities need to be handled, as well as any child entity dependencies that may also need to be deleted, which would otherwise be orphaned.
Command
DeletePriceBookCommand
Model
PriceCardDeleted (No current usages)
Pipeline
IDeleteEntityPipeline
Pipeline Argument
DeleteEntityArgument (handled within IDeleteEntityPipeline)
Pipeline Block
DeleteEntityBlock (handled within IDeleteEntityPipeline)
Components
Create Component
Naming Convention: Add<component><context>
Commerce Reference
Example
Controller Action
AddCartLine
Command
AddCartLineCommand
Model
LineAdded
Pipeline
AddCartLinePipeline
Pipeline Argument
CartLineArgument
Pipeline Block
AddCartLineBlock
Read Component
Naming Convention: N/A Components only exist to extend entities and therefore will not live in isolation to be queried. If a component was to be queried it would be to retrieve it in the context of an entity and therefore the entity would be retrieved instead.
Update Component
Naming Convention: Update<component><context>
Commerce Reference
Example
Controller Action
UpdateCartLine
Command
UpdateCartLineCommand
Model
LineUpdated
Pipeline
UpdateCartLinePipeline
Pipeline Argument
CartLineArgument
Pipeline Block
UpdateCartLineBlock
Delete Component
Naming Convention: Update<component><context>
Commerce Reference
Example
Controller Action
RemoveCartLine
Command
RemoveCartLineCommand
Model
LineRemoved (No current usages)
Pipeline
RemoveCartLinePipeline
Pipeline Argument
CartLineArgument
Pipeline Block
RemoveCartLineBlock
Business Tools
Pipeline Block Naming Convention
Example
Description
Get<Navigation Entity View>ViewBlock
GetInventoryNavigationViewBlock
Creates and constructs a navigation entity view
Get<Dashboard Entity View>ViewBlock
GetInventoryDashboardViewBlock
Creates and constructs a dashboard entity view
Get<Entities>ViewBlock
GetInventorySetsViewBlock
Creates and constructs an entity view for managed lists
Get<Entity>DetailsViewBlock
GetInventoryDetailsViewBlock
Creates and constructs an entity view for a specific entity
