Skip to main content
Anchor to CheckoutBrandingUpsertPayload

CheckoutBrandingUpsertPayload

payload

Return type for checkoutBrandingUpsert mutation.

•CheckoutBranding

Returns the new checkout branding settings.

•[CheckoutBrandingUpsertUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Updates the visual branding for a CheckoutProfile, customizing how checkout displays to customers. Creates new branding settings if none exist, or modifies existing settings.

The mutation accepts two levels of customization through the CheckoutBrandingInput input object. designSystem defines foundational brand attributes like colors, typography, and corner radius that apply consistently throughout checkout. customizations defines styles for specific parts of the UI, individual components, or groups of components like the header, buttons, form fields, and sections.

Changes to a published checkout profile display immediately in the store's checkout. You can preview draft profiles in the Shopify admin's checkout editor before publishing.

Learn more about checkout styling.

Arguments

•ID!
required

A globally-unique identifier.

Anchor to checkoutBrandingInputcheckoutBrandingInput
•CheckoutBrandingInput

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



Was this section helpful?