GiftCertificates
Lists all gift certificates.
View-Specific Information
Select
The add-in uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Id supports the =, >=, >, <=, < operators.
- Code supports the = operator.
- ToName supports the = operator.
- ToEmail supports the = operator.
- OrderId supports the = operator.
- FromEmail supports the = operator.
- FromName supports the = operator.
The rest of the filter is executed client-side within the add-in.
For example, the following queries are processed server-side:
SELECT * FROM GiftCertificates WHERE Id = 1
SELECT * FROM GiftCertificates WHERE Id >= 10
SELECT * FROM GiftCertificates WHERE Id > 5 AND Id < 50
SELECT * FROM GiftCertificates WHERE Code = 'ABC123'
SELECT * FROM GiftCertificates WHERE ToName = 'Jane Smith'
SELECT * FROM GiftCertificates WHERE ToEmail = '[email protected]'
SELECT * FROM GiftCertificates WHERE OrderId = 100
SELECT * FROM GiftCertificates WHERE FromEmail = '[email protected]'
SELECT * FROM GiftCertificates WHERE FromName = 'John Smith'
Columns
| Name | Type | 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. Possible values are: active, pending, disabled, or expired. |
| 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. Possible values are: birthday.html, girl.html, boy.html, celebration.html, christmas.html, or general.html. |
| Message | String | Text that is 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. |