API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

GiftCardCreateInput input object

Version unstable

Represents the input for creating a gift card.

Input fields

  • code (String)

    An optional custom code of the gift card. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9). A random code will be generated if the code is not provided.

  • customerId (ID)

    The ID of the customer for the gift card.

  • expiresOn (Date)

    The expiry date of the gift card. If unspecified, then the gift card will never expire.

  • initialValue (Decimal!) Required

    The initial value of the gift card in the shop's currency.

  • note (String)

    An optional note associated with the gift card. The note isn't visible to customers.

  • templateSuffix (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. When the argument is not supplied, the default gift_card.liquid template is used.

Version 2021-07 (Release candidate)

Represents the input for creating a gift card.

Input fields

  • code (String)

    An optional custom code of the gift card. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9). A random code will be generated if the code is not provided.

  • customerId (ID)

    The ID of the customer for the gift card.

  • expiresOn (Date)

    The expiry date of the gift card. If unspecified, then the gift card will never expire.

  • initialValue (Decimal!) Required

    The initial value of the gift card in the shop's currency.

  • note (String)

    An optional note associated with the gift card. The note isn't visible to customers.

  • templateSuffix (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. When the argument is not supplied, the default gift_card.liquid template is used.

Version 2021-04 (Latest)

Represents the input for creating a gift card.

Input fields

  • code (String)

    An optional custom code of the gift card. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9). A random code will be generated if the code is not provided.

  • customerId (ID)

    The ID of the customer for the gift card.

  • expiresOn (Date)

    The expiry date of the gift card. If unspecified, then the gift card will never expire.

  • initialValue (Decimal!) Required

    The initial value of the gift card in the shop's currency.

  • note (String)

    An optional note associated with the gift card. The note isn't visible to customers.

  • templateSuffix (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. When the argument is not supplied, the default gift_card.liquid template is used.