GiftCards
Stores digital or physical gift card records, including balance, currency, and issuance details.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the gift card. | |
| APIClientId | Long | True |
The unique identifier for the API client that issued the gift card. | |
| Balance | Decimal | True |
The remaining balance currently available on the gift card. | |
| Code | String | False |
The alphanumeric code representing the gift card. For security, this value is only visible at the time of creation. (Minimum: 8 characters; Maximum: 20 characters) | |
| CreatedAt | Datetime | True |
The date and time when the gift card was created, in ISO 8601 format. | |
| Currency | String | True |
The three-letter ISO 4217 currency code associated with the gift card. | |
| CustomerId | Long | True |
Customers.Id |
The unique identifier of the customer associated with the gift card. |
| DisabledAt | Datetime | True |
The date and time when the gift card was disabled, in ISO 8601 format. | |
| ExpiresOn | Date | False |
The expiration date of the gift card (in YYYY-MM-DD format). Returns null if the gift card does not expire. | |
| InitialValue | Decimal | False |
The original value of the gift card when it was issued. | |
| LastCharacters | String | True |
The last four characters of the gift card code. The full code is never retrievable for security reasons. | |
| LineItemId | Long | True |
OrdersItems.ItemId |
The unique identifier of the line item that triggered the creation of the gift card, if it originated from an order. |
| Note | String | False |
An optional internal note added by the merchant. Not visible to customers. | |
| OrderId | Long | True |
Orders.Id |
The unique identifier of the order that initiated the creation of the gift card, if applicable. |
| TemplateSuffix | String | False |
The suffix of the Liquid template used to render the gift card page online. For example, if set to 'birthday', the template gift_card.birthday.liquid is used. Defaults to gift_card.liquid when null. | |
| UserId | Long | True |
Users.Id |
The unique identifier of the staff member who issued the gift card, if created manually. |
| UpdatedAt | Datetime | True |
The date and time when the gift card was last updated, in ISO 8601 format. |