standardMetafieldDefinitionsEnable - admin-graphql - MUTATION

Version: unstable

Description:

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](https://shopify.dev/apps/metafields/definitions/standard-definitions).

Access Scopes

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

Arguments

• definitions: StandardMetafieldDefinitionsEnableInput! - The list of standard definitions to enable. Maximum of 25.

Returns

• definitions: MetafieldDefinition The list of definitions that were enabled.
• userErrors: StandardMetafieldDefinitionsEnableUserError! The list of errors that occurred from executing the mutation.

Examples

• Enable multiple standard definitions

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) { standardMetafieldDefinitionsEnable(definitions: $definitions) { definitions { id key namespace } userErrors { code field message } } }\",\n \"variables\": {\n    \"definitions\": [\n      {\n        \"namespace\": \"facts\",\n        \"key\": \"isbn\",\n        \"ownerType\": \"PRODUCT\",\n        \"pin\": false\n      },\n      {\n        \"namespace\": \"facts\",\n        \"key\": \"upc\",\n        \"ownerType\": \"PRODUCT\",\n        \"pin\": false\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {\n      standardMetafieldDefinitionsEnable(definitions: $definitions) {\n        definitions {\n          id\n          key\n          namespace\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"definitions\": [\n        {\n          \"namespace\": \"facts\",\n          \"key\": \"isbn\",\n          \"ownerType\": \"PRODUCT\",\n          \"pin\": false\n        },\n        {\n          \"namespace\": \"facts\",\n          \"key\": \"upc\",\n          \"ownerType\": \"PRODUCT\",\n          \"pin\": false\n        }\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {\n    standardMetafieldDefinitionsEnable(definitions: $definitions) {\n      definitions {\n        id\n        key\n        namespace\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"definitions\": [{\"namespace\"=>\"facts\", \"key\"=>\"isbn\", \"ownerType\"=>\"PRODUCT\", \"pin\"=>false}, {\"namespace\"=>\"facts\", \"key\"=>\"upc\", \"ownerType\"=>\"PRODUCT\", \"pin\"=>false}]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {\n    standardMetafieldDefinitionsEnable(definitions: $definitions) {\n      definitions {\n        id\n        key\n        namespace\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"definitions\" => [{\"namespace\"=>\"facts\", \"key\"=>\"isbn\", \"ownerType\"=>\"PRODUCT\", \"pin\"=>false}, {\"namespace\"=>\"facts\", \"key\"=>\"upc\", \"ownerType\"=>\"PRODUCT\", \"pin\"=>false}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {\n    standardMetafieldDefinitionsEnable(definitions: $definitions) {\n      definitions {\n        id\n        key\n        namespace\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"definitions\": [\n        {\n          \"namespace\": \"facts\",\n          \"key\": \"isbn\",\n          \"ownerType\": \"PRODUCT\",\n          \"pin\": false\n        },\n        {\n          \"namespace\": \"facts\",\n          \"key\": \"upc\",\n          \"ownerType\": \"PRODUCT\",\n          \"pin\": false\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation standardMetafieldDefinitionsEnable($definitions: [StandardMetafieldDefinitionsEnableInput!]!) {\n  standardMetafieldDefinitionsEnable(definitions: $definitions) {\n    definitions {\n      id\n      key\n      namespace\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "standardMetafieldDefinitionsEnable": {
        "definitions": [
          {
            "id": "gid://shopify/MetafieldDefinition/1071456144",
            "key": "isbn",
            "namespace": "facts"
          },
          {
            "id": "gid://shopify/MetafieldDefinition/1071456145",
            "key": "upc",
            "namespace": "facts"
          }
        ],
        "userErrors": []
      }
    }
  }