Promotions actions, commands, and pipelines

Version:

The following sections describe actions, commands, and pipelines related to promotions.

Promotion books

The following table describes the actions, commands, and pipelines pertaining to promotion books:

Action/Command/Pipeline	Description
`AddPromotionBook` `AddPromotionBookCommand` `AddPromotionBookPipeline`	Adds a promotion book. Requires a unique promotion book name.
`EditPromotionBook` `EditPromotionBookCommand` `EditPromotionBookPipeline`	Edits a promotion book.
`AssociateCatalog` `AssociateCatalogToBookCommand` `AssociateCatalogToBookPipeline`	Associates a promotion book to a specific catalog.
`DisassociateCatalog` `DisassociateCatalogFromBookCommand` `DisassociateCatalogFromBookPipeline`	Disassociates a promotion book from a specific catalog.
`GetPromotionBookAssociatedCatalogs` `GetBookAssociatedCatalogsCommand` `GetBookAssociatedCatalogsPipeline`	Retrieves all catalogs associated with a promotion book.

Promotions

The following table describes the actions, commands, and pipelines pertaining to promotions:

Action/Command/Pipeline	Description
`AddPromotion` `AddPromotionCommand` `AddPromotionPipeline`	Adds a promotion. Requires the parent promotion book name and a unique promotion name.
`EditPromotion` `EditPromotionCommand` `EditPromotionPipeline`	Edits a promotion. The promotion’s approval status must not be Approved.
`DuplicatePromotion` `DuplicatePromotionCommand` `DuplicatePromotionPipeline`	Duplicates a promotion.
`RequestPromotionApproval` `SetApprovalStatusCommand`	Changes a promotion’s approval status from Draft to ReadyForApproval.
`ApprovePromotion` `SetApprovalStatusCommand`	Changes a promotion's approval status from ReadyForApproval to Approve.
`RejectPromotion` `SetApprovalStatusCommand`	Changes a promotion’s approval status from ReadyForApproval to Draft.
`RetractPromotion` `SetApprovalStatusCommand`	Changes a promotion’s approval status from Approved back to Draft. Applicable only before the promotion is made fully active.
`DisablePromotion` `DisablePromotionCommand` `DisablePromotionPipeline`	Disables an approved promotion. Applicable when the promotion is approved and active.
`DeletePromotion` `DeletePromotionCommand` `DeletePromotionPipeline`	Deletes a promotion. The promotion’s approval status must not be Approved.
`EvaluatePromotionsQualificationsCommand` `EvaluatePromotionsQualificationsPipeline`	These are used as part during the runtime of the promotions service.
`DiscoverPromotionsPipeline`	This is used as part during the runtime of the promotions service.
`FilterQualifyingPromotionsPipeline`	Searches for promotions in the system.

Note

ApplyPromotionsBenefitsCommand and the corresponding pipeline are not used.

Qualifications

The following table describes the actions, commands, and pipelines pertaining to the Qualification component:

Action/Command/Pipeline	Description
`SelectQualification` `GetOperatorsCommand` `GetConditionsCommand`	Selects a qualification from all the qualifications available in the system. This action is implemented together with the AddQualification.
`AddQualification` `AddQualificationCommand` `AddQualificationPipeline`	Adds the selected qualification to a promotion. The promotion’s approval status must be Draft.
`EditQualification` `EditQualificationCommand` `EditQualificationPipeline`	Edits a promotion’s qualification. The promotion’s approval status must be Draft.
`DeleteQualification` `DeleteQualificationCommand` `DeleteQualificationPipeline`	Removes a qualification from a promotion. The promotion’s approval status must be Draft. All qualifications can be deleted from a promotion only if the promotion has no benefits.

Benefits

The following table describes the promotions actions, commands, and pipelines pertaining to the Benefit component:

Action/Command/Pipeline	Description
`SelectBenefit` `GetOperatorsCommand` `GetActionsCommand`	Selects a benefit from all the benefits available in the system.
`AddBenefit` `AddBenefitCommand` `AddBenefitPipeline`	Adds the selected benefit to a promotion. The promotion’s approval status must be Draft. The promotion must have at least one qualification.
`EditBenefit` `EditBenefitCommand` `AddBenefitPipeline`	Edits a promotion’s benefit. The promotion’s approval status must be Draft.
`DeleteBenefit` `DeleteBenefitCommand` `DeleteBenefitPipeline`	Removes a benefit from a promotion. The promotion’s approval status must be Draft.

Items

The following table describes the promotions actions, commands, and pipelines pertaining to the Item component:

Action/Command/Pipeline	Description
`AddItem` `AddPromotionItemCommand` `AddPromotionItemPipeline`	Adds an Item to a promotion. An item must be unique within a promotion. The promotion’s approval status must be Draft.
`RemoveItem` `RemovePromotionItemCommand` `RemovePromotionItemPipeline`	Removes an item from a promotion. The promotion’s approval status must be Draft.

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