Choose a version:

validationCreate

mutation

Requires write_validations access scope.

Creates a cart and checkout validation: a server-side rule enforced before a customer can complete checkout. Each validation is powered by a cart and checkout validation function that you provide using functionId or functionHandle.

Use validationCreate to apply custom rules at checkout, such as limiting item quantities, enforcing order minimums or maximums, or blocking checkout for restricted shipping addresses. Validations run on Shopify's servers and are enforced throughout checkout, so they can't be bypassed by the client.

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 validationvalidation

•ValidationCreateInput!

required

The input fields for a new validation.

Was this section helpful?

Anchor to ValidationCreatePayload returnsValidationCreatePayload returns

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

Was this section helpful?

Examples

validationCreate reference

Mutation Reference

mutation validationCreate($validation: ValidationCreateInput!) {

validationCreate(validation: $validation) {

userErrors {

field

message

}

validation {

# Validation fields

}

Input

{

"validation": {

"blockOnFailure": true,

"enable": true,

"functionHandle": "<your-functionHandle>",

"metafields": [

{

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

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

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

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

"value": "<your-value>"

}

"title": "<your-title>"

}

Variables

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

Schema

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

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