GiftCards
Lists, creates, and updates gift cards.
Table Specific Information
Select
The 本製品 uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the 本製品.
Retrieve all GiftCards.
SELECT * from GiftCards
Retrieve a gift card using the gift card ID.
SELECT * from GiftCards where id = 'gftc:3c0c38e043a742c58431e3cca603c5b9'
Insert
To create a gift card, you will need to specify the LocationId and gift card type. LocationId is a pseudo column used only while creating new gift card.
INSERT INTO GiftCards(LocationId, Type) VALUES('92BYHNBR6W77E','DIGITAL')
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Square-assigned ID of the gift card. |
Type | String | False |
The gift card type. |
GiftCardAccountNumberSource | String | False |
The source that generated the gift card account number (GAN). The default value is SQUARE. |
State | String | True |
The current gift card state. |
BalanceMoneyAmount | Int64 | True |
The current gift card balance amount. This balance is always greater than or equal to zero. |
BalanceMoneyCurrency | String | True |
The type of balance amount currency, in ISO 4217 format. |
GiftCardAccountNumber | String | False |
The gift card account number (GAN). Buyers can use the GAN to make purchases or check the gift card balance. |
CreatedAt | Datetime | True |
The timestamp when the gift card was created, in RFC 3339 format. In the case of a digital gift card, it is the time when you create a card (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API). |
CustomerIds | String | True |
The IDs of the customer profiles to whom this gift card is linked. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
LocationId | String |
The ID of the location where the gift card should be registered for reporting purposes. |