Skip to main content

Giftcards

We import giftcard products using ImportProducts. Example request:

{
"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 need to specify the handler we want to use for our giftcards. For our example, we are running with our generic APIGIFTCARD handler. This creates a separate GiftCardConfiguration. Make sure to check up on that configuration after import to link the configurations and handler to the (giftcard) product(s). This can be done in Admin Suite via the Financials module -> Giftcards chapter.

Physical giftcards don't need any further configuration besides the handler. Digital giftcards 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.

You can link an existing GiftCardConfigurationID to ImportProducts for adding new products to the same pre-configured giftcard setup. When no GiftCardConfigurationID is provided, you will have an unconfigured product that you can manually link to a new or existing giftcard.

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.