GiftCertificates
Lists all gift certificates.
Table Specific Information
Select
The component uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=, >=, >, <=, <' comparison.
- Code supports the '=' comparison.
- ToName supports the '=' comparison.
- ToEmail supports the '=' comparison.
- OrderId supports the '=' comparison.
- FromEmail supports the '=' comparison.
- FromName supports the '=' comparison.
The rest of the filter is executed client-side within the component.
For example, the following queries are processed server-side:
SELECT * FROM GiftCertificates WHERE Id = 1 SELECT * FROM GiftCertificates WHERE IsDefault = "true" SELECT * FROM GiftCertificates WHERE IsGroupForGuests = "true"
Columns
| Name | Type | References | Description |
| Id [KEY] | Integer | The ID of the gift certificate. | |
| Code | String | A unique string that the customer can input to redeem the gift certificate. | |
| Amount | Decimal | Value of the gift certificate. | |
| Status | String | Status of the gift certificate. | |
| Balance | Decimal | Remaining value of the gift certificate. | |
| ToName | String | Name of the recipient. | |
| ToEmail | String | Email of the recipient. | |
| OrderId | Integer | The ID of the order. | |
| Template | String | The email theme to use in the message sent to the recipient. | |
| Message | String | Text that will be sent to the recipient, such as Congratulations. | |
| FromName | String | Name of the customer who purchased the gift certificate. | |
| FromEmail | String | Email of the customer who purchased the gift certificate. | |
| CustomerId | Integer | The id of the customer placing the order. | |
| ExpiryDate | Datetime | Date on which the gift certificate is set to expire. | |
| PurchaseDate | Datetime | Date the gift certificate was purchased. | |
| CurrencyCode | String | The currency code. |