Choose a version:

validationUpdate

mutation

Requires write_validations access scope.

Updates a cart and checkout validation. Use validationUpdate to rename it, toggle whether it's enabled at checkout, change its blockOnFailure behavior, or update its metafields.

Validation errors always block checkout progress. The blockOnFailure field controls whether runtime exceptions, such as timeouts, also block checkout.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID representing the validation to update.

Anchor to validationvalidation

•ValidationUpdateInput!

required

The input fields to update a validation.

Was this section helpful?

Anchor to ValidationUpdatePayload returnsValidationUpdatePayload returns

Anchor to userErrorsuserErrors •[ValidationUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to validationvalidation •Validation: The updated validation.

Was this section helpful?

Examples

validationUpdate reference

Mutation Reference

mutation validationUpdate($id: ID!, $validation: ValidationUpdateInput!) {

validationUpdate(id: $id, validation: $validation) {

userErrors {

field

message

}

validation {

# Validation fields

}

Input

{

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

"validation": {

"blockOnFailure": true,

"enable": true,

"metafields": [

{

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

"key": "<your-key>",

"namespace": "<your-namespace>",

"type": "<your-type>",

"value": "<your-value>"

}

"title": "<your-title>"

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "validation": {
    "blockOnFailure": true,
    "enable": true,
    "metafields": [
      {
        "id": "gid://shopify/<objectName>/10079785100",
        "key": "<your-key>",
        "namespace": "<your-namespace>",
        "type": "<your-type>",
        "value": "<your-value>"
      }
    ],
    "title": "<your-title>"
  }
}

Schema

input ValidationUpdateInput {
  blockOnFailure: Boolean
  enable: Boolean
  metafields: [MetafieldInput!]
  title: String
}

input MetafieldInput {
  id: ID
  key: String
  namespace: String
  type: String
  value: String
}