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
CartGiftCertificate
OBJECT
Copy page
Cart gift certificate
Fields
entityId
String
Required
ID of this gift certificate.
name
String
Required
GiftCertificate-provided name that will appear in the control panel.
theme
CartGiftCertificateTheme
Required
Currently supports Birthday, Boy, Celebration, Christmas, General, and Girl. None returned if all the above mentioned themes are disabled.
Show 7 enum values
amount
Money
Required
Value must be between 1.00 and 1,000.00 in the store's default currency.
Show 4 fields
amountInDisplayCurrency
Money
Required
Amount in display currency.
Show 4 fields
isTaxable
Boolean
Required
Whether or not the gift certificate is taxable.
sender
CartGiftCertificateSender
Required
Sender of the gift certificate.
Show 2 fields
recipient
CartGiftCertificateRecipient
Required
Recipient of the gift certificate.
Show 2 fields
message
String
Optional
Message that will be sent to the gift certificate's recipient. Limited to 200 characters.
Referenced by
Fields
CartLineItems.giftCertificates
