checkoutAndAccountsConfigurationUpdate

mutation

Requires write_checkout_and_accounts_configurations access scope or write_checkout_settings access scope. Also: User must have manage_checkout_settings permission and shop must have access to the checkout and accounts editor as well as the contextualized checkouts and customer accounts feature. When modifying configuration overrides, user must have view_markets and create_and_edit_markets permissions.

Updates a checkout and accounts configuration.

Anchor to Arguments

Arguments

Anchor to configurationconfiguration

•CheckoutAndAccountsConfigurationInput!

required

The intended changes to the configuration.

Anchor to idid

•ID!

required

The ID of the configuration to update.

Was this section helpful?

Anchor to CheckoutAndAccountsConfigurationUpdatePayload returnsCheckoutAndAccountsConfigurationUpdatePayload returns

Anchor to configurationconfiguration •CheckoutAndAccountsConfiguration: The updated configuration.
Anchor to userErrorsuserErrors •[CheckoutAndAccountsConfigurationUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

checkoutAndAccountsConfigurationUpdate reference

Mutation Reference

mutation checkoutAndAccountsConfigurationUpdate($id: ID!, $configuration: CheckoutAndAccountsConfigurationInput!) {

checkoutAndAccountsConfigurationUpdate(id: $id, configuration: $configuration) {

configuration {

# CheckoutAndAccountsConfiguration fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"configuration": {

"overrides": [

{

"id": "gid://shopify/<objectName>/10079785100",

"branding": {}

}

"branding": {

"designTokens": {},

"components": {},

"surfaces": {}

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "configuration": {
    "overrides": [
      {
        "id": "gid://shopify/<objectName>/10079785100",
        "branding": {}
      }
    ],
    "branding": {
      "designTokens": {},
      "components": {},
      "surfaces": {}
    }
  }
}

Schema

input CheckoutAndAccountsConfigurationInput {
  overrides: [CheckoutAndAccountsConfigurationOverrideInput!]
  branding: CheckoutAndAccountsConfigurationBrandingInput
}

input CheckoutAndAccountsConfigurationOverrideInput {
  id: ID
  branding: CheckoutAndAccountsConfigurationBrandingInput
}

input CheckoutAndAccountsConfigurationBrandingInput {
  designTokens: CheckoutAndAccountsConfigurationBrandingDesignTokensInput
  components: CheckoutAndAccountsConfigurationBrandingComponentsInput
  surfaces: CheckoutAndAccountsConfigurationBrandingSurfacesInput
}