metaobjectCreate - admin-graphql - MUTATION

Version: 2025-01

Description:

Creates a new metaobject.

Access Scopes

`write_metaobjects` access scope.

Arguments

• metaobject: MetaobjectCreateInput! - The parameters for the metaobject to create.

Returns

• metaobject: Metaobject The created metaobject.
• userErrors: MetaobjectUserError! The list of errors that occurred from executing the mutation.

Examples

• Create a metaobject

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CreateMetaobject($metaobject: MetaobjectCreateInput!) { metaobjectCreate(metaobject: $metaobject) { metaobject { handle season: field(key: \\\"season\\\") { value } } userErrors { field message code } } }\",\n \"variables\": {\n    \"metaobject\": {\n      \"type\": \"lookbook\",\n      \"handle\": \"winter-2023\",\n      \"fields\": [\n        {\n          \"key\": \"season\",\n          \"value\": \"winter\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CreateMetaobject($metaobject: MetaobjectCreateInput!) {\n      metaobjectCreate(metaobject: $metaobject) {\n        metaobject {\n          handle\n          season: field(key: \"season\") {\n            value\n          }\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"metaobject\": {\n        \"type\": \"lookbook\",\n        \"handle\": \"winter-2023\",\n        \"fields\": [\n          {\n            \"key\": \"season\",\n            \"value\": \"winter\"\n          }\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 CreateMetaobject($metaobject: MetaobjectCreateInput!) {\n    metaobjectCreate(metaobject: $metaobject) {\n      metaobject {\n        handle\n        season: field(key: \"season\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"metaobject\": {\n    \"type\": \"lookbook\",\n    \"handle\": \"winter-2023\",\n    \"fields\": [{\"key\"=>\"season\", \"value\"=>\"winter\"}]\n  }\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 CreateMetaobject($metaobject: MetaobjectCreateInput!) {\n    metaobjectCreate(metaobject: $metaobject) {\n      metaobject {\n        handle\n        season: field(key: \"season\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"metaobject\" => [\n    \"type\" => \"lookbook\",\n    \"handle\" => \"winter-2023\",\n    \"fields\" => [{\"key\"=>\"season\", \"value\"=>\"winter\"}],\n  ],\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 CreateMetaobject($metaobject: MetaobjectCreateInput!) {\n    metaobjectCreate(metaobject: $metaobject) {\n      metaobject {\n        handle\n        season: field(key: \"season\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"metaobject\": {\n        \"type\": \"lookbook\",\n        \"handle\": \"winter-2023\",\n        \"fields\": [\n          {\n            \"key\": \"season\",\n            \"value\": \"winter\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CreateMetaobject($metaobject: MetaobjectCreateInput!) {\n  metaobjectCreate(metaobject: $metaobject) {\n    metaobject {\n      handle\n      season: field(key: \"season\") {\n        value\n      }\n    }\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}"
        

  input: {
    "metaobject": {
      "type": "lookbook",
      "handle": "winter-2023",
      "fields": [
        {
          "key": "season",
          "value": "winter"
        }
      ]
    }
  }

  response: {
    "data": {
      "metaobjectCreate": {
        "metaobject": {
          "handle": "winter-2023",
          "season": {
            "value": "winter"
          }
        },
        "userErrors": []
      }
    }
  }