Retrieve registered pipelines

Abstract

How to retrieve information about pipelines currently running in the Commerce Engine, such as pipeline dependencies, pipeline blocks, and arguments, so that you can better determine how to implement custom functionality.

You use the Get Registered Pipelines sample request in Postman to retrieve a list of all Commerce Engine pipelines that are registered in a given instance of a Commerce Engine. You can then search the returned response for a specific pipeline and view existing blocks. The request returns information that you can use to identify dependencies between pipelines, identify what blocks a given pipeline is running, what arguments a pipeline receives and returns, and so on. This information can help you understand Commerce processes and business logic, so that you can determine how to implement custom functionality.

To retrieve registered pipelines from a running instance of a Commerce Engine:

  1. In the Postman Collections pane, expand the SitecoreCommerce_DevOps collection.

  2. In the SitecoreCommerce_DevOp collection, click Get Registered Pipelines, and then click Send.

    The response to the request lets you view all the blocks (from various pipelines) that are invoked when a pipeline runs. For example, the following sample shows all the blocks that the IcreateOrderPipeline pipeline executes when running.

      {
                "Name": "ICreateOrderPipeline",
                "Policies": [],
                "Namespace": "Sitecore.Commerce.Plugin.Orders",
                "Receives": "Sitecore.Commerce.Plugin.Orders.CartEmailArgument",
                "Returns": "Sitecore.Commerce.Plugin.Orders.Order",
                "Blocks": [
                    {
                        "Name": "CreateFederatedPaymentBlock",
                        "Policies": [],
                        "Namespace": "Plugin.Sample.Payments.Braintree",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.CartEmailArgument",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.CartEmailArgument"
                    },
                    {
                        "Name": "CreateOrderBlock",
                        "Policies": [],
                        "Namespace": "Sitecore.Commerce.Plugin.Orders",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.CartEmailArgument",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.Order"
                    },
                    {
                        "Name": "UpdateCouponUsageBlock",
                        "Policies": [],
                        "Namespace": "Sitecore.Commerce.Plugin.Coupons",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.Order",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.Order"
                    },
                    {
                        "Name": "IncrementOrderPerformanceCountersBlock",
                        "Policies": [],
                        "Namespace": "Sitecore.Commerce.Plugin.Orders",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.Order",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.Order"
                    },
                    {
                        "Name": "IOrderPlacedPipeline",
                        "Policies": [],
                        "Namespace": "Sitecore.Commerce.Plugin.Orders",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.Order",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.Order"
                    },
                    {
                        "Name": "IItemOrderedPipeline",
                        "Policies": [],
                        "Namespace": "Sitecore.Commerce.Plugin.Orders",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.Order",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.Order"
                    },
                    {
                        "Name": "IPersistOrderPipeline",
                        "Policies": [],
                        "Namespace": "Sitecore.Commerce.Plugin.Orders",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.Order",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.Order"
                    },
                    {
                        "Name": "ClearAndPersistCartBlock",
                        "Policies": [],
                        "Namespace": "Sitecore.Commerce.Plugin.Orders",
                        "Receives": "Sitecore.Commerce.Plugin.Orders.Order",
                        "Returns": "Sitecore.Commerce.Plugin.Orders.Order"
                    }
                ],
                "Comment": ""