GiftCards
Contains issued gift card records, including balances, codes, and issuance dates. Available only for Shopify Plus stores.
Table-Specific Information
Note: Access to the GiftCards table is restricted to Shopify accounts with Shopify Plus membership. If your account does not include this tier, the table may return an empty result set or indicate that the resource is unavailable.
Select
The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The connector processes other filters client-side within the connector.
- Id supports the '=, IN' comparison operators.
- ExpiresOn supports the '=, !=, <, >, >=, <=' comparison operators.
- CreatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
- InitialValueAmount supports the '=, !=, <, >, >=, <=' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM GiftCards WHERE Id = 'Val1'
SELECT * FROM GiftCards WHERE ExpiresOn = '2023-01-01'
SELECT * FROM GiftCards WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM GiftCards WHERE InitialValueAmount = '100.00'
Insert
The following columns can be used to create a new record:
Note, ExpiresOn, InitialValueAmount, CustomerId, RecipientAttributesRecipientId, RecipientAttributesPreferredName, RecipientAttributesMessage, RecipientAttributesSendNotificationAt
Update
The following columns can be updated:
Note, ExpiresOn, CustomerId, RecipientAttributesRecipientId, RecipientAttributesPreferredName, RecipientAttributesMessage, RecipientAttributesSendNotificationAt, Enabled
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally unique identifier for the gift card record. | |
| Enabled | Bool | True |
Indicates whether the gift card is currently active and available for use. | |
| Note | String | False |
An internal note associated with the gift card, visible only to store staff and not to the customer. | |
| ExpiresOn | Date | False |
The date when the gift card expires and can no longer be redeemed. | |
| LastCharacters | String | True |
The final four visible characters of the gift card code, shown for reference and verification. | |
| MaskedCode | String | True |
The masked version of the full gift card code, hiding all but the last four characters for security purposes. | |
| DeactivatedAt | Datetime | True |
The date and time when the gift card was deactivated and made unusable. | |
| UpdatedAt | Datetime | True |
The timestamp indicating when the gift card record was last updated. | |
| CreatedAt | Datetime | True |
The timestamp indicating when the gift card was first created in Shopify. | |
| BalanceAmount | Decimal | True |
The remaining balance available on the gift card, represented as a decimal value. | |
| BalanceCurrencyCode | String | True |
The ISO currency code for the balance amount of the gift card. | |
| InitialValueAmount | Decimal | True |
The original monetary value of the gift card when it was issued. | |
| InitialValueCurrencyCode | String | True |
The ISO currency code representing the currency of the initial gift card value. | |
| CustomerId | String | False |
A globally unique identifier linking the gift card to the customer who owns or redeemed it. | |
| RecipientAttributesRecipientId | String | False |
A globally unique identifier for the intended gift card recipient, if different from the purchaser. | |
| RecipientAttributesPreferredName | String | False |
The recipient's preferred name as provided for the delivery of the gift card. | |
| RecipientAttributesMessage | String | False |
A personalized message included with the gift card for the recipient. | |
| RecipientAttributesSendNotificationAt | Datetime | False |
The scheduled date and time when the gift card notification will be sent to the recipient. Delivery typically occurs within one hour of this time. | |
| OrderId | String | True |
A globally unique identifier linking the gift card to the order through which it was purchased or issued. |