1. Commands and pipelines

Catalog commands and pipelines

Version:

The following table describes the catalog commands and pipelines:

Command/PipelineDescription
CreateCatalogCommand

CreateCatalogPipeline		Creates a new instance of a catalog in the Commerce Engine.

Parameters:

  • catalogName: internal name for the catalog
  • catalogDisplayName: display name for the catalog
  • priceBookName: name of the price book associated with the catalog
  • promotionBookName: name of the promotion book associated with the catalog
EditCatalogCommand

EditCatalogPipeline		Makes changes to an existing catalog.

Parameters:

  • entityId: identifier for the catalog entity
  • catalogDisplayName: display name for the catalog
  • priceBookName: name of the price book associated with the catalog
  • promotionBookName: name of the promotion book associated with the catalog
GetCatalogCommand

GetCatalogPipeline		Retrieves a specific catalog defined in the system.

Parameters:

  • Id: identifier of the catalog (string)
GetCatalogsCommand

GetCatalogsPipeline		Retrieves all catalogs defined in the system.

Parameters: none
GetCatalogItemsCommand

GetCatalogItemsPipeline		Retrieves all of the sellable items associated with the catalog.
UpdateSellableItemPurchasableCommandDetermines whether the sellable item is purchasable or not.

  • true : the sellable item will be made purchasable and the PurchasablePolicyrestriction will be removed
  • false : the sellable item cannot be purchased.
InitializeRelationshipDefinitionsBlockCreates default relationship types to establish relationships between catalog entities (e.g. category to sellable item).
If you have suggestions for improving this article, let us know!