How it worksAnchor link to section titled "How it works"
The GraphQL Admin API includes types and their associated fields for applying styling to checkout, checkout queue, checkout UI extensions, and customer account pages. Styles are applied across these surfaces.
You can save styling changes to a draft checkout, which you can preview in the checkout editor, or to a production checkout on a live site. Review the following sections to familiarize yourself with API data structures and the role of checkout profiles in styling.
Data structuresAnchor link to section titled "Data structures"
The branding API is comprised of the following objects:
designSystem: Sets the design language for the entire experience. Its values are set to establish your design system, which encompasses design components such as spacing, colors, typography, and other visual elements that are used throughout the branding process. The
designSystemobject represents the standardized design principles for the brand.
designSystemprovides foundational tokens that are consumed in the
customizations: Styles specific parts of the UI, individual components, or groups of components. With some customizations, you can pull from design system values. Other customizations retrieve their values from a pre-defined array of tokens or a float range. These customizations can be made to adjust the interface to better align with a brand's identity or specific requirements.
The following example JSON object shows the separate objects and their inner contents:
Checkout profileAnchor link to section titled "Checkout profile"
Checkout branding properties apply to a checkout profile ID. Profiles are useful to test branding against a draft profile before publishing any changes.
The following example uses the
checkoutProfiles query to retrieve a list of available checkout profile IDs. The
is_published parameter highlights which checkout profile applies to your store's current live checkout. You supply the
id in checkout branding mutations to customize your checkout's branding properties.
Resetting stylesAnchor link to section titled "Resetting styles"
With the Checkout Branding API you can write parent fields to
null to reset some or all of the settings to the default.
The following example resets checkout color schemes to the defaults:
The following example resets all checkout styling to the defaults:
LimitationsAnchor link to section titled "Limitations"
You can't currently customize styling for individual pages. Styles are applied across checkout, checkout queue, checkout UI extensions, and customer account pages.
SVG is not a supported image type for styling checkout.
Developer tools and resourcesAnchor link to section titled "Developer tools and resources"
Checkout UI extensions API reference
Consult the API reference for checkout UI targets and their respective types.
Components for checkout UI extensions
Learn about the components that are available in checkout UI extensions.
Checkout extension configuration
Learn about the properties that you can configure in your checkout UI extension.
Get startedAnchor link to section titled "Get started"
Follow these tutorials and learn how to apply custom styles.