Gift cards

Current version: 9.2

Configuration

You can find all configuration for the gift card subsystem in the Sitecore.Commerce.GiftCards.config file. Here you will find all details for the entities, pipelines, and repositories used by the gift card system.

Entities

The default gift card entities for Commerce Connect only assume some of the basic gift card information that will be used across all commerce systems. It is expected that you will need to extend these entities.

You can use the following two entities defined in the Connect system for gift cards to extend functionality to fulfill your requirements:

  • GiftCard - represents a gift card owned by a customer and contains information such as balance and original amount.

  • GiftCardPaymentInfo - enables the use of a gift card as a payment method by extending the PaymentInfo class and adding a property to store the amount to charge.

To extend any of these default entities,  you can create a new class that inherits from the relevant type, and then patch the relevant entity under commerce.Entities in the Sitecore.Commerce.GiftCards.config file.

Pipeline

There is a single pipeline in the gift card implementation that enables most basic functionality:

  • The getGiftCard pipeline -  used, for example, to retrieve a gift card object.

Note

For more information, see the Commerce Connect Developer Reference.

Do you have some feedback for us?

If you have suggestions for improving this article,