Ucommerce
  • Ucommerce Next Gen
    • Getting Started
      • Prerequisites
      • Licensing
      • Ucommerce Templates
      • Headless Template
      • MVC Template
    • Headless
      • Postman Collection
      • Headless API Authentication
        • Token endpoint - Authorization Header
        • Authorization Scopes
        • Refreshing the Access Token
      • Reference
        • Cart
        • Cart / Order Line Items
        • Shipment
        • Billing
        • Promotion Codes
        • Price Groups
        • Payment Methods
        • Countries
        • Shipping Methods
        • Catalogs
        • Cart Custom Properties
        • Line Item Custom Properties
        • Orders
        • Views for Cart modifying operations
      • Custom Headless APIs
      • Error Handling
      • Pagination
      • Deprecation
    • Backoffice Authentication
      • Microsoft Entra ID Example
      • Auth0 Authentication Example
    • Definitions
      • What is a Definition
    • Search and indexing
      • Configuration
      • Indexing
        • Index Definitions
        • Facets
        • Indexing Prices
        • Suggestions
        • Custom Data
      • Searching
    • Payment Providers
      • Stripe Provider Integration
      • Implementing a custom payment provider
    • Data Import
    • Miscellaneous
      • Media
      • Price Group Inheritance
      • Price Group Criteria
      • Soft Deletion Of Entities
      • Logging
      • OpenTelemetry
    • Extensions
      • Extending Pipelines
        • Order Processing Pipelines
        • Checkout Pipelines
      • Changing Service Behavior
        • Images
        • Content
      • Custom Headless APIs
      • Extend the Backoffice
        • Custom UI Components
      • Custom Editor UI
      • Custom Promotion Criteria
      • Custom Price Group Criteria
    • How-To
      • Migrate from Classic
        • Common database issues
      • Entities from code
        • Bootstrapping data on startup
        • Product Definitions & Fields
      • Discover pipelines and their tasks
      • Executing a pipeline
    • Integrations
      • Umbraco Media Delivery API
      • App Slices
        • Product Picker
  • Release Notes
  • Contact Us
Powered by GitBook
On this page

Was this helpful?

  1. Ucommerce Next Gen
  2. How-To

Discover pipelines and their tasks

PreviousProduct Definitions & FieldsNextExecuting a pipeline

Last updated 1 year ago

Was this helpful?

Before extending a pipeline, you need to know which one to extend. To make it easier to discover our pipelines, an endpoint is available from the backoffice with the URL http(s)://{yourdomain}/ucommerce/api/v1.0/pipelines

The endpoint uses like the rest of the backoffice.

Calling the endpoint will return JSON containing all pipelines that are registered in the service collection of your app with input and output types, namespace, tasks (in order of execution), and the interface each task implements. The result will be grouped by entity and look like this:

"order": [
    {
        "tasksImplement": "IPipelineTask<GetOrderInput, GetOrderOutput>",
        "inputType": "GetOrderInput",
        "name": "GetOrderPipeline",
        "namespace": "Ucommerce.Web.Core.Pipelines.Order.GetOrder",
        "outputType": "GetOrderOutput",
        "tasks": [
            "GetOrderPipelineTask"
        ]
    },
    {
        "tasksImplement": "IPipelineTask<GetOrderNumberInput, GetOrderNumberOutput>",
        "inputType": "GetOrderNumberInput",
        "name": "GetOrderNumberPipeline",
        "namespace": "Ucommerce.Web.Core.Pipelines.Order.GetOrderNumber",
        "outputType": "GetOrderNumberOutput",
        "tasks": [
            "GetOrderNumberPipelineTask"
        ]
    },
    ...more order-related pipelines
],
...more entities

The endpoint will also reflect your own changes to the app, and will help you know if your custom tasks have been registered correctly, as your pipeline tasks will be shown in the appropriate list after registration.

Using to call the endpoint makes it easy to collapse irrelevant parts of the response or search for the things you need.

authentication
Postman