---
title: checkoutBranding - GraphQL Admin
description: >-
  Returns the visual customizations for checkout for a given checkout profile.


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

  [checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert)

  mutation and the checkout branding
  [tutorial](https://shopify.dev/docs/apps/checkout/styling).
api_version: 2024-10
api_name: admin
type: query
api_type: graphql
source_url:
  html: 'https://shopify.dev/docs/api/admin-graphql/2024-10/queries/checkoutBranding'
  md: >-
    https://shopify.dev/docs/api/admin-graphql/2024-10/queries/checkoutBranding.txt
---

# checkout​Branding

query

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

To learn more about updating checkout branding settings, refer to the [checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert) mutation and the checkout branding [tutorial](https://shopify.dev/docs/apps/checkout/styling).

## Arguments

* checkout​Profile​Id

  [ID!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID)

  required

  A globally-unique identifier.

***

## Possible returns

* Checkout​Branding

  [Checkout​Branding](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/CheckoutBranding)

  The settings of checkout visual customizations.

  To learn more about updating checkout branding settings, refer to the [checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert) mutation.

***

## Examples

* ### Get global colors

  #### Description

  This example demonstrates how to read the global colors from a checkout profile.

  #### Query

  ```graphql
  query GetGlobalColors {
    checkoutBranding(checkoutProfileId: "gid://shopify/CheckoutProfile/235093654") {
      designSystem {
        colors {
          global {
            success
            warning
            critical
            info
            brand
            accent
            decorative
          }
        }
      }
    }
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "query GetGlobalColors { checkoutBranding(checkoutProfileId: \"gid://shopify/CheckoutProfile/235093654\") { designSystem { colors { global { success warning critical info brand accent decorative } } } } }"
  }'
  ```

  #### Remix

  ```javascript
  const { admin } = await authenticate.admin(request);

  const response = await admin.graphql(
    `#graphql
    query GetGlobalColors {
      checkoutBranding(checkoutProfileId: "gid://shopify/CheckoutProfile/235093654") {
        designSystem {
          colors {
            global {
              success
              warning
              critical
              info
              brand
              accent
              decorative
            }
          }
        }
      }
    }`,
  );

  const data = await response.json();
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    query GetGlobalColors {
      checkoutBranding(checkoutProfileId: "gid://shopify/CheckoutProfile/235093654") {
        designSystem {
          colors {
            global {
              success
              warning
              critical
              info
              brand
              accent
              decorative
            }
          }
        }
      }
    }
  QUERY

  response = client.query(query: query)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: `query GetGlobalColors {
      checkoutBranding(checkoutProfileId: "gid://shopify/CheckoutProfile/235093654") {
        designSystem {
          colors {
            global {
              success
              warning
              critical
              info
              brand
              accent
              decorative
            }
          }
        }
      }
    }`,
  });
  ```

  #### Response

  ```json
  {
    "checkoutBranding": {
      "designSystem": {
        "colors": {
          "global": {
            "success": "#FFFFFF",
            "warning": "#F0F0F0",
            "critical": "#AABBCC",
            "info": "#ABCDAB",
            "brand": "#ABCDAB",
            "accent": "#0F0F0F",
            "decorative": "#1F2928"
          }
        }
      }
    }
  }
  ```

## Get global colors

[Open in GraphiQL](http://localhost:3457/graphiql?query=query%20GetGlobalColors%20%7B%0A%20%20checkoutBranding\(checkoutProfileId%3A%20%22gid%3A%2F%2Fshopify%2FCheckoutProfile%2F235093654%22\)%20%7B%0A%20%20%20%20designSystem%20%7B%0A%20%20%20%20%20%20colors%20%7B%0A%20%20%20%20%20%20%20%20global%20%7B%0A%20%20%20%20%20%20%20%20%20%20success%0A%20%20%20%20%20%20%20%20%20%20warning%0A%20%20%20%20%20%20%20%20%20%20critical%0A%20%20%20%20%20%20%20%20%20%20info%0A%20%20%20%20%20%20%20%20%20%20brand%0A%20%20%20%20%20%20%20%20%20%20accent%0A%20%20%20%20%20%20%20%20%20%20decorative%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D)

```javascript
const { admin } = await authenticate.admin(request);


const response = await admin.graphql(
  `#graphql
  query GetGlobalColors {
    checkoutBranding(checkoutProfileId: "gid://shopify/CheckoutProfile/235093654") {
      designSystem {
        colors {
          global {
            success
            warning
            critical
            info
            brand
            accent
            decorative
          }
        }
      }
    }
  }`,
);


const data = await response.json();
```

## Response

JSON

```json
{
  "checkoutBranding": {
    "designSystem": {
      "colors": {
        "global": {
          "success": "#FFFFFF",
          "warning": "#F0F0F0",
          "critical": "#AABBCC",
          "info": "#ABCDAB",
          "brand": "#ABCDAB",
          "accent": "#0F0F0F",
          "decorative": "#1F2928"
        }
      }
    }
  }
}
```