validationCreate

mutation

Requires write_validations access scope.

Creates a validation.

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?

Mutation Reference

mutation validationCreate($validation: ValidationCreateInput!) {

validationCreate(validation: $validation) {

userErrors {

field

message

}

validation {

# Validation fields

}

Input

{

"validation": {

"blockOnFailure": true,

"enable": true,

"functionId": "<your-functionId>",

"metafields": [

{

"description": "<your-description>",

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

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

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

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

"value": "<your-value>"

}

"title": "<your-title>"

}

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

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

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