Skip to main content
Anchor to CheckoutBranding

CheckoutBranding

object

Requires access to checkout branding settings and the shop must be on a Plus plan or a Development store plan.

The settings of checkout visual customizations.

To learn more about updating checkout branding settings, refer to the checkoutBrandingUpsert mutation.

Anchor to FieldsFields

Anchor to customizationscustomizations
•CheckoutBrandingCustomizations

The customizations that apply to specific components or areas of the user interface.

Anchor to designSystemdesignSystem
•CheckoutBrandingDesignSystem

The design system allows you to set values that represent specific attributes of your brand like color and font. These attributes are used throughout the user interface. This brings consistency and allows you to easily make broad design changes.

Was this section helpful?

Anchor to QueriesQueries

Anchor to checkoutBrandingcheckoutBranding
•query

Returns the visual customizations for checkout for a given checkout profile.

To learn more about updating checkout branding settings, refer to the checkoutBrandingUpsert mutation and the checkout branding tutorial.

Was this section helpful?

Anchor to MutationsMutations

Anchor to checkoutBrandingUpsertcheckoutBrandingUpsert
•mutation

Updates the checkout branding settings for a checkout profile.

If the settings don't exist, then new settings are created. The checkout branding settings applied to a published checkout profile will be immediately visible within the store's checkout. The checkout branding settings applied to a draft checkout profile could be previewed within the admin checkout editor.

To learn more about updating checkout branding settings, refer to the checkout branding tutorial.

Arguments

Anchor to checkoutBrandingInputcheckoutBrandingInput
•CheckoutBrandingInput

The input fields to use to upsert the checkout branding settings (pass null to reset them to default).

Anchor to checkoutProfileIdcheckoutProfileId
•ID!required

A globally-unique identifier.

Fields

Anchor to checkoutBrandingcheckoutBranding
•CheckoutBranding

Returns the new checkout branding settings.

Anchor to userErrorsuserErrors
•[CheckoutBrandingUpsertUserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?