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
CheckoutPromotionBanner
OBJECT
Copy page
The checkout promotion banner
Fields
entityId
Integer
Required
The checkout promotion banner ID.
type
CheckoutPromotionBannerType
Required
Type of the banner.
Allowed values:
APPLIED
ELIGIBLE
PROMOTION
UPSELL
locations
list of
CheckoutPromotionBannerLocations
Required
The list of the locations where the banner will display.
Allowed values:
CART_PAGE
CHECKOUT_PAGE
HOME_PAGE
PRODUCT_PAGE
text
String
Required
Text of the banner.
Referenced by
Fields
CheckoutPromotion.banners
