For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
Storefront
Types
Objects
GiftCertificate
OBJECT
Copy page
Gift certificate details.
Fields
amount
Money
Required
The amount of the gift certificate.
Show 4 fields
balance
Money
Required
The remaining balance of the gift certificate.
Show 4 fields
code
String
Required
The gift certificate code.
currencyCode
String
Required
The ISO-4217 currency code of the gift certificate.
status
GiftCertificateStatus
Required
The status of the gift certificate.
Allowed values:
ACTIVE
DISABLED
EXPIRED
PENDING
recipient
GiftCertificateCustomerInfo
Required
The recipient information for the gift certificate.
Show 2 fields
sender
GiftCertificateCustomerInfo
Required
The sender information for the gift certificate.
Show 2 fields
purchasedAt
DateTimeExtended
Required
The date and time when the gift certificate was purchased.
Show 1 field
theme
GiftCertificateTheme
Required
The theme of the gift certificate.
Show 6 enum values
message
String
Optional
The message included with the gift certificate.
expiresAt
DateTimeExtended
Optional
The expiration date and time of the gift certificate, if applicable.
Show 1 field
html
String
Optional
The HTML content of the gift certificate.
Referenced by
Fields
Site.giftCertificate
