Gift Card Product Object


A gift card product is a template that defines what a purchasable gift card looks like, including its name, description, image, available denominations, and expiration policy. When a customer buys a gift card, an individual gift card instance is created based on the product's configuration.

Properties
createdDatestringRead-onlyformat date-time

Date and time the gift card product was created.


customVariantCustomVariant

Custom variant that allows buyers to choose their own gift card amount within a defined range. A product can have both preset variants and a custom variant.


descriptionstringmaxLength 3000

Gift card product description.


One Of

fixedExpirationDatestringformat date-time

Fixed expiration date for all gift cards created from this product.


relativeExpirationDateRelativeExpirationDate

Expiration period relative to the date of purchase.


expirationTypestring

Expiration type for gift cards created from this product.


extendedFieldsExtendedFields

Custom field data for the gift card product object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUID

Gift card product ID.


imageImage

Gift card product image. Only images from the Wix Media Manager are supported. To use an external image, first upload it to the Wix Media Manager.

When setting the image, you must provide at least id, width, and height. The id is the file name from the image URL. For example, for https://static.wixstatic.com/media/5cc69183e7954e2c9760fa2383870992.jpg, the id is 5cc69183e7954e2c9760fa2383870992.jpg.


namestringmaxLength 55

Gift card product name.


presetVariantsArray <PresetVariant>minItems 0maxItems 200

List of preset variants with predefined denominations that buyers can choose from. A product can have both preset variants and a custom variant.

When updating, the entire list is replaced. There's no way to update an individual preset variant.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the gift card product is updated. To prevent conflicting changes, the current revision must be passed when updating the gift card product.

Ignored when creating a gift card product.


updatedDatestringRead-onlyformat date-time

Date and time the gift card product was last updated.

Did this help?