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
CheckoutGiftCertificate
OBJECT
Copy page
The checkout gift certificate.
Fields
entityId
Integer
Required
The gift certificate entity ID.
code
String
Required
The gift certificate code.
balance
Money
Required
The balance remaining for gift certificate.
Show 4 fields
balanceInDisplayCurrency
Money
Required
Balance remaining in display currency for gift certificate.
Show 4 fields
remaining
Money
Required
Remaining balance in gift certificate.
Show 4 fields
remainingInDisplayCurrency
Money
Required
Remaining balance in display currency in gift certificate.
Show 4 fields
used
Money
Required
The total value of the gift certificate used in the checkout.
Show 4 fields
usedInDisplayCurrency
Money
Required
The total value of the gift certificate used in the checkout in display currency.
Show 4 fields
purchaseDate
DateTimeExtended
Required
The date when the gift certificate was purchased.
Show 1 field
Referenced by
Fields
Checkout.giftCertificates
