Skip to main content

Choose a version:

Validation

object

Requires read_validations access scope.

A checkout server side validation installed on the shop.

Anchor to Fields and connectionsFields and connections

Anchor to blockOnFailureblockOnFailure •Boolean!non-null: Whether the validation should block on failures other than expected violations.
Anchor to enabledenabled •Boolean!non-null: Whether the validation is enabled on the merchant checkout.
Anchor to errorHistoryerrorHistory •FunctionsErrorHistory: The error history on the most recent version of the validation function.
Anchor to idid •ID!non-null: Global ID for the validation.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection!non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to shopifyFunctionshopifyFunction •ShopifyFunction!non-null: The Shopify Function implementing the validation.
Anchor to titletitle •String!non-null: The merchant-facing validation name.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection!non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to validation validation •query: Validation available on the shop.
Anchor to validations validations •query: Validations available on the shop.

Was this section helpful?

Anchor to MutationsMutations

validationCreate

•mutation

Creates a validation.

Anchor to validationvalidation •ValidationCreateInput!required: The input fields for a new validation.

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

validationUpdate

•mutation

Update a validation.

Anchor to idid •ID!required: The ID representing the validation to update.
Anchor to validationvalidation •ValidationUpdateInput!required: The input fields to update a validation.

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?

Anchor to InterfacesInterfaces

Anchor to HasMetafieldDefinitions HasMetafieldDefinitions •interface
Anchor to HasMetafields HasMetafields •interface
Anchor to Node Node •interface

Was this section helpful?