GiftCards
Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription)
Table-Specific Information
Select
The 本製品 uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExpiresOn supports the '=,!=,<,>,>=,<=' comparison operators.
- CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
- InitialValueAmount supports the '=,!=,<,>,>=,<=' comparison operators.
The 本製品 processes other filters client-side within the 本製品.
For example, the following queries are processed server-side:
SELECT * FROM GiftCards WHERE Id = 'VALUE'
SELECT * FROM GiftCards WHERE ExpiresOn < '2000-01-01'
SELECT * FROM GiftCards WHERE CreatedAt < '2000-01-01 01:00:00.0'
SELECT * FROM GiftCards WHERE InitialValueAmount < '100.000000'
Insert
The following columns can be used to create a new record:
Note, ExpiresOn, InitialValueAmount, CustomerId
Update
The following columns can be updated:
Note, ExpiresOn, CustomerId
Delete
You can delete entries by specifying the Id.
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
A globally-unique ID. | |
Enabled | Bool | True |
Whether the gift card is enabled. | |
Note | String | False |
The note associated with the gift card, which is not visible to the customer. | |
DisabledAt | Datetime | True |
The date and time at which the gift card was disabled. | |
ExpiresOn | Date | False |
The date at which the gift card will expire. | |
LastCharacters | String | True |
The final four characters of the gift card code. | |
MaskedCode | String | True |
The gift card code. Everything but the final four characters is masked. | |
CreatedAt | Datetime | True |
The date and time at which the gift card was created. | |
BalanceAmount | Decimal | True |
Decimal money amount. | |
BalanceCurrencyCode | String | True |
Currency of the money. | |
InitialValueAmount | Decimal | True |
Decimal money amount. | |
InitialValueCurrencyCode | String | True |
Currency of the money. | |
CustomerId | String | False |
A globally-unique ID. | |
OrderId | String | True |
A globally-unique ID. |