The Gift cards application comes from the Multi channel sales module of the Comarch ERP Enterprise system. The application is used to create individual gift cards and to review and edit existing gift cards. Every gift card created in the application is based on a previously defined gift card type (the Gift card types application), from which it inherits the default configuration (currency, value, validity period, method of use, accounting parameters).

Opening a single gift card and making changes is possible only in single-record mode – the application then presents the data of one selected gift card. To manage gift cards in bulk (reviewing and filtering multiple gift cards), use the Cockpit: Gift cards application.

Application description

The application consists of a header. It contains the key attributes of the gift card, which uniquely identify the gift card and describe its current status.

Header

The header contains fields that identify the gift card and describe its current status. Fields in the panel:

• Number – consists of two fields:
  • Type – the gift card type taken from the Gift card types A mandatory field, available under the [Value assistant] button. After selecting the gift card type, the gift card fields are pre-filled with the default values from the type.
  • Number – the unique number of the gift card. A mandatory field. The number must be unique within the gift card type. The length of the number results from the configuration of the Number length field in the gift card type.
• Status – the current status of the gift card. A non-editable field – the value is set automatically by the system. Available values: Created, Active, Blocked, Disabled. Default value for a new gift card: Created. A detailed description of the statuses can be found in the general document Gift cards.
• Value – the current monetary value of the gift card (amount and currency). The default value is taken from the Gift card amount field of the gift card type. The currency must match the currency defined in the gift card type.
• Gift card creation time point – the date and time the gift card was created in the system. The field is filled in automatically.
• Valid from – until – the validity period of the gift card. The default value for the Valid from date is the current date, while Valid until is calculated as Valid from + Days valid in days (a gift card type field). When the gift card expires, its status is automatically changed to Disabled.
• Customer – the customer (a partner with the Customer role) to whom the gift card is assigned. The field is available only for gift cards whose type has the Personalized parameter selected. A mandatory field for personalized gift cards. The field is editable only until the new gift card is saved. The list of available customers includes partners that have the Customer role in one of the organizations assigned to the gift card type.

Cooperation with adapters

Gift cards are exchanged between the system and the adapters via the Gift card export application as well as web services and BIS interfaces. The way a gift card is handled may differ depending on the adapter.

Comarch POS

The Comarch POS adapter supports the full life cycle of an internal gift card.

Information on handling gift cards in Comarch POS can be found in the document Handling of vouchers.

Cloud

The Cloud adapter provides the web service com.sem.ext.app.mcs.loyalty.giftcard.rest.GiftCardsService supporting the creation and redemption of gift cards in online stores. Within the scope supported by the adapter:

• the online store calls the web service requesting the creation of a new gift card (or several gift cards), providing the gift card type and, optionally, the value and validity period; if the value or validity period are not provided, the default values from the gift card type are used
• after the gift card is created, the web service returns the gift card number and its status (initially Created)
• the gift card can be activated at any time after its creation (e.g. after payment confirmation) using the activateGiftCard method – the status changes from Created to Active
• when the gift card is added to the cart, the online store may optionally call the web service that verifies the gift card’s validity and its available balance
• before the order is confirmed, the store performs a mandatory gift card verification – this blocks the simultaneous use of the same gift card in another channel
• after payment confirmation, the store passes the gift card number and the amount used; the system updates the gift card balance and, if the balance reaches zero, automatically changes the gift card status to Disabled

REST

Base class path: com.sem.ext.app.mcs.loyalty.giftcard.rest.GiftCardsService

All endpoints use the POST method. Input and output format: application/json.

Available methods:

• POST /createGiftCards – creates one or more gift cards.
  Request body: List<GiftCardCreateData> (JSON array). Required field: type. Optional fields: value, valid from, valid until, customer.
• POST /isGiftCardValid – returns the current status of an existing gift card.
  Request body: a single GiftCardData Required fields: number, type.
• POST /redeemGiftCard – redeems an amount from an active gift card and records an entry in the operation history.
  Request body: GiftCardData. Required fields: number, type, amount. Optional field: documentData.
• POST /activateGiftCard – changes the gift card status from CREATED to ACTIVE.
  Request body: GiftCardData. Required fields: number, type.