checkout Brandingquery
query
2024-10latest
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.
Arguments
A globally-unique identifier.
Was this section helpful?
CheckoutBranding possible returns
The settings of checkout visual customizations.
To learn more about updating checkout branding settings, refer to the checkoutBrandingUpsert mutation.
Was this section helpful?
Code examples for QUERY: checkoutBranding
Query Reference for QUERY: checkoutBranding
"{\n checkoutBranding(checkoutProfileId) {\n # CheckoutBranding fields\n }\n}"
Input Reference for QUERY: checkoutBranding
Schema Reference for QUERY: checkoutBranding
Display Examples for QUERY: checkoutBranding
[ { "example": { "type_name": "checkoutbranding", "title": "Get global colors", "description": "This example demonstrates how to read the global colors from a checkout profile.", "query_string": "query GetGlobalColors {\n checkoutBranding(checkoutProfileId: \"gid://shopify/CheckoutProfile/235093654\") {\n designSystem {\n colors {\n global {\n success\n warning\n critical\n info\n brand\n accent\n decorative\n }\n }\n }\n }\n}", "query_arguments": { "checkoutProfileId": "gid://shopify/CheckoutProfile/235093654" }, "response": { "data": { "checkoutBranding": { "designSystem": { "colors": { "global": { "success": "#FFFFFF", "warning": "#F0F0F0", "critical": "#AABBCC", "info": "#ABCDAB", "brand": "#ABCDAB", "accent": "#0F0F0F", "decorative": "#1F2928" } } } } } }, "api_name": "admin", "minimum_api_version": "2023-10", "maximum_api_version": "unstable", "location": "/components/checkouts/graph_api/test/unit/graph_api/admin/checkout_branding/branding_test.rb", "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GetGlobalColors { checkoutBranding(checkoutProfileId: \\\"gid://shopify/CheckoutProfile/235093654\\\") { designSystem { colors { global { success warning critical info brand accent decorative } } } } }\"\n}'\n", "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query GetGlobalColors {\n checkoutBranding(checkoutProfileId: \"gid://shopify/CheckoutProfile/235093654\") {\n designSystem {\n colors {\n global {\n success\n warning\n critical\n info\n brand\n accent\n decorative\n }\n }\n }\n }\n }`,\n);\n\nconst data = await response.json();\n", "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query GetGlobalColors {\n checkoutBranding(checkoutProfileId: \"gid://shopify/CheckoutProfile/235093654\") {\n designSystem {\n colors {\n global {\n success\n warning\n critical\n info\n brand\n accent\n decorative\n }\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n", "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query GetGlobalColors {\n checkoutBranding(checkoutProfileId: \"gid://shopify/CheckoutProfile/235093654\") {\n designSystem {\n colors {\n global {\n success\n warning\n critical\n info\n brand\n accent\n decorative\n }\n }\n }\n }\n }`,\n});\n", "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n query GetGlobalColors {\n checkoutBranding(checkoutProfileId: \"gid://shopify/CheckoutProfile/235093654\") {\n designSystem {\n colors {\n global {\n success\n warning\n critical\n info\n brand\n accent\n decorative\n }\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n" }, "titleStringKey": "arguments", "inputVariableEntries": [ { "arg": { "name": "checkoutProfileId", "description": "A globally-unique identifier.", "type": { "kind": "SCALAR", "name": "ID", "list": false, "non_null": true }, "defaultValue": null, "typeSignature": "ID!", "isDeprecated": false, "deprecationReason": null }, "key": "checkoutProfileId", "argValue": " \"gid://shopify/CheckoutProfile/235093654\"", "typeKind": "QUERY" } ] } ]