Skip to main content

Giftcard Products

docs image

Giftcard Products

Selling giftcards

When it comes to giftcards as a product type in EVA, it's important to know you can create them in the same way you create any other product: via ImportProducts.

Extensive giftcard docs

While this page gives some general information on using giftcards in EVA, it focuses mostly on the creation of the giftcard products themselves. For extensive information on giftcard use and configuration, please see: Giftcards.

EVA offers several direct integrations with 3rd party providers, so-called handlers:

  • Via Adyen: SVS
  • Direct integration: Givex and Intersolve

And then there's EVA's whitelabel solution, allowing you to integrate with most other providers.

You can either create your giftcard configuration first, in Admin Suite's Giftcards chapter, or create the giftcard product and link it to the configuration afterwards.

Creating giftcard products​

When adding a giftcard product via ImportProducts, you either add one or both of the following properties:

  • By specifying a GiftCardConfigurationID, a new giftcard product will be added to that existing configuration regardless of the giftcard's data (read: Content).
  • By specifying a GiftcardType (such as APIGIFTCARD or Intersolve), EVA will create a new product of that giftcard type.

If the new product's data does not match the exact data of the giftcards in a current giftcard type, a new one will be created.

Sample​

The following two samples show creating a physical and digital giftcard product via ImportProducts.

{
    "SystemID": "GC",
    "Products": [
        {
            "ID": "1234",
            "Name": "Physical Giftcard",
            "CustomID": "1234",
            "TaxCode": "Zero",
            "Type": {
                "Stock": true,
                "Giftcard": true,
                "AllowCustomPricing": true
            },
            "GiftCardType": "APIGIFTCARD",
            "GiftCardIsDigital": false,
            "Content": [
                {
                    "PublicationStatuses": ["public"]
                }
            ]
        }
    ]
}

In this request, we specify the handler (read: GiftCardType) we want to use for our giftcards. For our example, we are running with EVA's generic APIGIFTCARD handler.

As mentioned: our sample does not contain an an existing GiftCardConfigurationID, which means a new one will be created.

This combination results in a new giftcard configuration for the APIGIFTCARD type.

Similarly, when using the GiftCardType with an existing configuration in the ImportProducts service, it adds new products to the same pre-configured giftcard setup. If the configuration is not present, the ImportProducts service considers the provided giftcard data and creates new giftcard handlers accordingly.

Digital giftcards​

Physical giftcards don't need any further configuration besides the handler. Digital giftcards however need some stencils to support sending them through e-mail. We need to set up the following two stencils:

  • GiftCardOrderShippedConfirmation with target mail.
  • GiftCardOrderShippedConfirmation with target PDF.