Commands and pipelines

Relationship commands and pipelines

Version:

The following table describes the relationship commands and pipelines:

Important

Some commands, like the AssociateSellableItemToParentCommand, change the entity version in the database. Verify the version before calling an update operation because update operations require the entity version to match the value in the database.

Command/Pipeline	Description
`AssociateCategoryToParentCommand` `AssociateCategoryToParentPipeline`	Associates a category to a parent entity. Parameters: `catalogId`: identifier for the catalog to which the category belongs `parentId`: identifier for the parent entity `categoryID`: identifier for the category
`AssociateSellableItemToParentCommand` `AssociateSellableItemToParentPipeline`	Associates a sellable item to a parent entity. Parameters: `catalogId`: identifier for the catalog `parentId`: identifier for the parent entity `sellableItemID`: identifier for the sellable item
`CreateRelationshipCommand` `CreateRelationshipPipeline`	Creates a relationship between two entities. Parameters: `catalogName`: identifier for the catalog `sourceName`: name of the source entity `targetName` : name of the target entity `relationshipType`: type of relationship between the two entities
`CreateRelationshipTypeCommand` `CreateRelationshipTypePipeline`	Creates a relationship type (for the association of specific entities). Parameters: `relationshipTypeName`: name of the relationship type `relationshipTypeDisplayName`: display name for the relationship type `relationshipTypeDescription`: description of the relationship type `sourceType`: the type of entity for the source (e.g., catalog, category, sellable item) `targetType`: the type of entity for the target (e.g., catalog, category, sellable item) `renderList`: indicates whether a list is rendered on the matching entity view
`DeleteRelationshipCommand` `DeleteRelationshipPipeline`	Deletes a relationship between two entities. Parameters: `catalogName`: identifier for the catalog `sourceName`: name of the source entity `targetName` : name of the target entity `relationshipType`: type of relationship between the two entities
`EditRelationshipTypeCommand` `EditRelationshipTypePipeline`	Modifies a relationship type (for the association of specific entities). Parameters: `relationshipType`: type of the relationship `relationshipTypeDisplayName`: display name for the relationship type `relationshipTypeDescription`: description of the relationship type `renderList`: indicates whether a list is rendered on the matching entity view
`GetRelationshipTypeCommand` `GetRelationshipTypePipeline`	Retrieves the specified relationship type. Parameters: `arg`: the relationship type
`GetRelationshipTypesCommand` `GetRelationshipTypesPipeline`	Retrieves a list of all relationship types defined in the system. Parameters: none.

If you have suggestions for improving this article, let us know!