GiftCard object
Represents a gift card.
Required access
read_gift_cards
access scope. Also: The API client must be a private or custom app installed on a Shopify Plus store.
On this page
Fields
-
balance (
MoneyV2!
)The balance of the gift card.
-
createdAt (
DateTime!
)The date when the gift card was created.
-
customer (
Customer
)The customer for whom the gift card was created.
-
disabledAt (
DateTime
)The date when the gift card was disabled.
-
enabled (
Boolean!
)Indicates if the gift card is enabled.
-
expiresOn (
Date
)The date when the gift card will expire.
-
id (
ID!
)Globally unique identifier.
-
initialValue (
MoneyV2!
)The initial value of the gift card.
-
lastCharacters (
String!
)The final four characters of the gift card code.
-
maskedCode (
String!
)The code of the gift card, with everything except the final four characters masked.
-
note (
String
)A description of the gift card, which is not visible to customers.
-
order (
Order
)The order of the gift card.
Types that return GiftCard
Mutations for GiftCard
-
Creates a gift card.
-
Disable a gift card.
-
Update a gift card.
Implements
Represents a gift card.
Required access
read_gift_cards
access scope. Also: The API client must be a private or custom app installed on a Shopify Plus store.
On this page
Fields
-
balance (
MoneyV2!
)The balance of the gift card.
-
createdAt (
DateTime!
)The date when the gift card was created.
-
customer (
Customer
)The customer for whom the gift card was created.
-
disabledAt (
DateTime
)The date when the gift card was disabled.
-
enabled (
Boolean!
)Indicates if the gift card is enabled.
-
expiresOn (
Date
)The date when the gift card will expire.
-
id (
ID!
)Globally unique identifier.
-
initialValue (
MoneyV2!
)The initial value of the gift card.
-
lastCharacters (
String!
)The final four characters of the gift card code.
-
maskedCode (
String!
)The code of the gift card, with everything except the final four characters masked.
-
note (
String
)A description of the gift card, which is not visible to customers.
-
order (
Order
)The order of the gift card.
Types that return GiftCard
Mutations for GiftCard
-
Creates a gift card.
-
Disable a gift card.
-
Update a gift card.
Implements
Represents a gift card.
Required access
read_gift_cards
access scope. Also: The API client must be a private or custom app installed on a Shopify Plus store.
On this page
Fields
-
balance (
MoneyV2!
)The balance of the gift card.
-
createdAt (
DateTime!
)The date when the gift card was created.
-
customer (
Customer
)The customer for whom the gift card was created.
-
disabledAt (
DateTime
)The date when the gift card was disabled.
-
enabled (
Boolean!
)Indicates if the gift card is enabled.
-
expiresOn (
Date
)The date when the gift card will expire.
-
id (
ID!
)Globally unique identifier.
-
initialValue (
MoneyV2!
)The initial value of the gift card.
-
lastCharacters (
String!
)The final four characters of the gift card code.
-
maskedCode (
String!
)The code of the gift card, with everything except the final four characters masked.
-
note (
String
)A description of the gift card, which is not visible to customers.
-
order (
Order
)The order of the gift card.
Types that return GiftCard
Mutations for GiftCard
-
Creates a gift card.
-
Disable a gift card.
-
Update a gift card.