GiftCards
Lists gift cards and balances (requires read_gift_cards; available for Shopify Plus/private or custom application).
Table-Specific Information
Select
The provider uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The provider processes other filters client-side within the provider.
- 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 | False |
The globally unique identifier of the gift card. | |
| Enabled | Bool | True |
Indicates whether the gift card is active and can be used. | |
| Note | String | False |
An internal note associated with the gift card, not visible to the customer. | |
| ExpiresOn | Date | False |
The expiration date of the gift card. | |
| LastCharacters | String | True |
The last four characters of the gift card code. | |
| MaskedCode | String | True |
The masked gift card code, showing only the last four characters. | |
| DeactivatedAt | Datetime | True |
The date and time when the gift card was deactivated. | |
| UpdatedAt | Datetime | True |
The date and time when the gift card was last updated. | |
| CreatedAt | Datetime | True |
The date and time when the gift card was created. | |
| BalanceAmount | Decimal | True |
The current balance of the gift card as a decimal value. | |
| BalanceCurrencyCode | String | True |
The currency of the gift card balance. | |
| InitialValueAmount | Decimal | True |
The original value of the gift card as a decimal amount. | |
| InitialValueCurrencyCode | String | True |
The currency of the original gift card value. | |
| CustomerId | String | False |
The unique identifier of the customer associated with the gift card. | |
| RecipientAttributesRecipientId | String | False |
The unique identifier of the gift card recipient. | |
| RecipientAttributesPreferredName | String | False |
The preferred name of the recipient of the gift card. | |
| RecipientAttributesMessage | String | False |
The custom message included with the gift card. | |
| RecipientAttributesSendNotificationAt | Datetime | False |
The scheduled date and time when the gift card notification is sent to the recipient. The message is sent within one hour of the scheduled time. | |
| OrderId | String | True |
The unique identifier of the order that generated the gift card. |