Anchor to section titled 'undefined'

checkoutBranding
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.

Anchor to section titled 'Arguments'

Arguments

Anchor to checkoutProfileId
checkoutProfileId
ID!
required

A globally-unique identifier.

Was this section helpful?
Anchor to section titled 'CheckoutBranding possible returns'

CheckoutBranding possible returns

Anchor to CheckoutBranding
CheckoutBranding
CheckoutBranding
Access requirements

The settings of checkout visual customizations.

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

Was this section helpful?
Get global colors
Hide code
DescriptionCopy
query GetGlobalColors {
  checkoutBranding(checkoutProfileId: "gid://shopify/CheckoutProfile/235093654") {
    designSystem {
      colors {
        global {
          success
          warning
          critical
          info
          brand
          accent
          decorative
        }
      }
    }
  }
}
Hide code
Response
JSON
{
  "checkoutBranding": {
    "designSystem": {
      "colors": {
        "global": {
          "success": "#FFFFFF",
          "warning": "#F0F0F0",
          "critical": "#AABBCC",
          "info": "#ABCDAB",
          "brand": "#ABCDAB",
          "accent": "#0F0F0F",
          "decorative": "#1F2928"
        }
      }
    }
  }
}