Choose a version:

GiftCardCreateInput

input_object

The input fields to issue a gift card.

Anchor to FieldsFields

Anchor to codecode •String: The gift card's code. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9). It isn't case sensitive. If not provided, then a random code will be generated.
Anchor to customerIdcustomerId •ID: The ID of the customer who will receive the gift card. Requires write_customers access_scope.
Anchor to expiresOnexpiresOn •Date: The date at which the gift card will expire. If not provided, then the gift card will never expire.
Anchor to initialValueinitialValue •Decimal! non-null: The initial value of the gift card.
Anchor to notenote •String: The note associated with the gift card, which isn't visible to the customer.
Anchor to notifynotify •Boolean Default:true: Whether to enable sending of notifications to the customer and recipient. Defaults to true. Setting this to false will prevent all notifications to the customer or recipient, unless the property is changed on a subsequent update.
Anchor to recipientAttributesrecipientAttributes •GiftCardRecipientInput: The recipient attributes of the gift card.
Anchor to templateSuffixtemplateSuffix •String: The suffix of the Liquid template that's used to render the gift card online. For example, if the value is birthday, then the gift card is rendered using the template gift_card.birthday.liquid. If not provided, then the default gift_card.liquid template is used.

Was this section helpful?