metafieldDefinitionPin
mutation

Choose a version:

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

You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.

Anchor to section titled 'Arguments'

Arguments

Anchor to definitionId definitionId ID! required: The ID of the metafield definition to pin.

Was this section helpful?

Anchor to section titled 'MetafieldDefinitionPinPayload returns'

MetafieldDefinitionPinPayload returns

Anchor to MetafieldDefinitionPinPayload.pinnedDefinition pinnedDefinition MetafieldDefinition: The metafield definition that was pinned.
Anchor to MetafieldDefinitionPinPayload.userErrors userErrors [MetafieldDefinitionPinUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: metafieldDefinitionPin

Query Reference for MUTATION: metafieldDefinitionPin

"mutation metafieldDefinitionPin($definitionId: ID!) {\n  metafieldDefinitionPin(definitionId: $definitionId) {\n    pinnedDefinition {\n      # MetafieldDefinition fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: metafieldDefinitionPin

"{\n  \"definitionId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: metafieldDefinitionPin

""

Display Examples for MUTATION: metafieldDefinitionPin

[
  {
    "example": {
      "type_name": "metafielddefinitionpin",
      "title": "Pin a metafield definition",
      "description": "                Pin a metafield definition so it's automatically displayed in the Shopify admin for the corresponding resource.\n",
      "query_string": "mutation metafieldDefinitionPin($definitionId: ID!) {\n  metafieldDefinitionPin(definitionId: $definitionId) {\n    pinnedDefinition {\n      name\n      key\n      namespace\n      pinnedPosition\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "definitionId": "gid://shopify/MetafieldDefinition/1071456171"
      },
      "response": {
        "data": {
          "metafieldDefinitionPin": {
            "pinnedDefinition": {
              "name": "Instructions to wash your product",
              "key": "wash",
              "namespace": "instructions",
              "pinnedPosition": 1
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/content/metafields/test/unit/graph_api/admin/mutations/metafield_definition_pin_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation metafieldDefinitionPin($definitionId: ID!) { metafieldDefinitionPin(definitionId: $definitionId) { pinnedDefinition { name key namespace pinnedPosition } userErrors { field message } } }\",\n \"variables\": {\n    \"definitionId\": \"gid://shopify/MetafieldDefinition/1071456171\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation metafieldDefinitionPin($definitionId: ID!) {\n    metafieldDefinitionPin(definitionId: $definitionId) {\n      pinnedDefinition {\n        name\n        key\n        namespace\n        pinnedPosition\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"definitionId\": \"gid://shopify/MetafieldDefinition/1071456171\"\n    },\n  },\n);\n\nconst data = await response.json();\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 metafieldDefinitionPin($definitionId: ID!) {\n    metafieldDefinitionPin(definitionId: $definitionId) {\n      pinnedDefinition {\n        name\n        key\n        namespace\n        pinnedPosition\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"definitionId\": \"gid://shopify/MetafieldDefinition/1071456171\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation metafieldDefinitionPin($definitionId: ID!) {\n      metafieldDefinitionPin(definitionId: $definitionId) {\n        pinnedDefinition {\n          name\n          key\n          namespace\n          pinnedPosition\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"definitionId\": \"gid://shopify/MetafieldDefinition/1071456171\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation metafieldDefinitionPin($definitionId: ID!) {\n    metafieldDefinitionPin(definitionId: $definitionId) {\n      pinnedDefinition {\n        name\n        key\n        namespace\n        pinnedPosition\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"definitionId\" => \"gid://shopify/MetafieldDefinition/1071456171\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "definitionId",
          "description": "The ID of the metafield definition to pin.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "definitionId",
        "argValue": " \"gid://shopify/MetafieldDefinition/1071456171\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

metafieldDefinitionPinmutation

Arguments

MetafieldDefinitionPinPayload returns

metafieldDefinitionPin
mutation