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
Inputs
CartGiftCertificateInput
INPUT
Copy page
Cart gift certificate input object
Input fields
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.
Show 7 enum values
amount
String
Required
Value must be between 1.00 and 1,000.00 in the store's default currency.
quantity
Integer
Required
The total number of certificates
sender
CartGiftCertificateSenderInput
Required
Sender of the gift certificate.
Show 2 fields
recipient
CartGiftCertificateRecipientInput
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
AddCartLineItemsDataInput.giftCertificates
CreateCartInput.giftCertificates
CreateCheckoutInput.giftCertificates
UpdateCartLineItemDataInput.giftCertificate
