Choose a version:

standardMetafieldDefinitionsEnable

mutation

Requires API client to have access to the resource type associated with the metafield definition owner type.

Enables multiple specified standard metafield definitions from their templates as a single transaction. This API is idempotent so any previously-enabled standard definitions will not cause a failure. However, invalid inputs or other user errors will prevent all of the requested definitions from being enabled.

Refer to the list of standard metafield definition templates.

Arguments

Anchor to definitionsdefinitions •[StandardMetafieldDefinitionsEnableInput!]!required: The list of standard definitions to enable. Maximum of 25.

Was this section helpful?

Anchor to StandardMetafieldDefinitionsEnablePayload returnsStandardMetafieldDefinitionsEnablePayload returns

Anchor to definitionsdefinitions •[MetafieldDefinition!]: The list of definitions that were enabled.
Anchor to userErrorsuserErrors •[StandardMetafieldDefinitionsEnableUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Enable multiple standard definitions
standardMetafieldDefinitionsEnable reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {

standardMetafieldDefinitionsEnable(definitions: $definitions) {

definitions {

key

namespace

}

userErrors {

code

field

message

}

}`,

{

variables: {

"definitions": [

{

"namespace": "facts",

"key": "isbn",

"ownerType": "PRODUCT",

"pin": false

{

"namespace": "facts",

"key": "upc",

"ownerType": "PRODUCT",

"pin": false

}

]

);

const data = await response.json();

mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {
  standardMetafieldDefinitionsEnable(definitions: $definitions) {
    definitions {
      id
      key
      namespace
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) { standardMetafieldDefinitionsEnable(definitions: $definitions) { definitions { id key namespace } userErrors { code field message } } }",
 "variables": {
    "definitions": [
      {
        "namespace": "facts",
        "key": "isbn",
        "ownerType": "PRODUCT",
        "pin": false
      },
      {
        "namespace": "facts",
        "key": "upc",
        "ownerType": "PRODUCT",
        "pin": false
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {
    standardMetafieldDefinitionsEnable(definitions: $definitions) {
      definitions {
        id
        key
        namespace
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "definitions": [
        {
          "namespace": "facts",
          "key": "isbn",
          "ownerType": "PRODUCT",
          "pin": false
        },
        {
          "namespace": "facts",
          "key": "upc",
          "ownerType": "PRODUCT",
          "pin": false
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {
      standardMetafieldDefinitionsEnable(definitions: $definitions) {
        definitions {
          id
          key
          namespace
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "definitions": [
        {
          "namespace": "facts",
          "key": "isbn",
          "ownerType": "PRODUCT",
          "pin": false
        },
        {
          "namespace": "facts",
          "key": "upc",
          "ownerType": "PRODUCT",
          "pin": false
        }
      ]
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {
    standardMetafieldDefinitionsEnable(definitions: $definitions) {
      definitions {
        id
        key
        namespace
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "definitions": [{"namespace"=>"facts", "key"=>"isbn", "ownerType"=>"PRODUCT", "pin"=>false}, {"namespace"=>"facts", "key"=>"upc", "ownerType"=>"PRODUCT", "pin"=>false}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"definitions": [

{

"namespace": "facts",

"key": "isbn",

"ownerType": "PRODUCT",

"pin": false

{

"namespace": "facts",

"key": "upc",

"ownerType": "PRODUCT",

"pin": false

}

]

}

Response

JSON

{

"standardMetafieldDefinitionsEnable": {

"definitions": [

{

"id": "gid://shopify/MetafieldDefinition/1071456144",

"key": "isbn",

"namespace": "facts"

{

"id": "gid://shopify/MetafieldDefinition/1071456145",

"key": "upc",

"namespace": "facts"

}

"userErrors": []

}