Anchor to section titled 'undefined'metaobject
metaobject
mutation
2024-07
Requires write access scope.
Creates a new metaobject.
Anchor to section titled 'Arguments'
Arguments
The parameters for the metaobject to create.
Was this section helpful?
Anchor to section titled 'MetaobjectCreatePayload returns'
MetaobjectCreatePayload returns
The created metaobject.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: metaobjectCreate
Query Reference for MUTATION: metaobjectCreate
"mutation metaobjectCreate($metaobject: MetaobjectCreateInput!) {\n metaobjectCreate(metaobject: $metaobject) {\n metaobject {\n # Metaobject fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: metaobjectCreate
"{\n \"metaobject\": {\n \"capabilities\": {\n \"onlineStore\": {\n \"templateSuffix\": \"<your-templateSuffix>\"\n },\n \"publishable\": {\n \"status\": \"ACTIVE\"\n }\n },\n \"fields\": [\n {\n \"key\": \"<your-key>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"handle\": \"<your-handle>\",\n \"type\": \"<your-type>\"\n }\n}"Schema Reference for MUTATION: metaobjectCreate
"input MetaobjectCreateInput {\n capabilities: MetaobjectCapabilityDataInput\n fields: [MetaobjectFieldInput!]\n handle: String\n type: String!\n}\n\ninput MetaobjectCapabilityDataInput {\n onlineStore: MetaobjectCapabilityDataOnlineStoreInput\n publishable: MetaobjectCapabilityDataPublishableInput\n}\n\ninput MetaobjectFieldInput {\n key: String!\n value: String!\n}\n"Display Examples for MUTATION: metaobjectCreate
[
{
"example": {
"type_name": "metaobjectcreate",
"title": "Create a metaobject",
"description": "To create a metaobject, you can use the `metaobjectCreate` mutation along with the metaobject as an\nargument providing the type and fields you want to create. A `MetaobjectDefinition` with the specified\ntype and fields must already exist.\n\nThe following example creates a new \"Lookbook\" metaobject with the `winter-2023` handle\nand the season field set to `winter`.\n",
"query_string": "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}",
"variables": {
"metaobject": {
"type": "lookbook",
"handle": "winter-2023",
"fields": [
{
"key": "season",
"value": "winter"
}
]
}
},
"response": {
"data": {
"metaobjectCreate": {
"metaobject": {
"handle": "winter-2023",
"season": {
"value": "winter"
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/content/metaobjects/test/unit/graph_api/admin/mutations/metaobject_create_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 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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "metaobject",
"description": "The parameters for the metaobject to create.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MetaobjectCreateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "MetaobjectCreateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "metaobject",
"argValue": " {\"type\":\"lookbook\",\"handle\":\"winter-2023\",\"fields\":[{\"key\":\"season\",\"value\":\"winter\"}]}",
"typeKind": "MUTATION"
}
]
}
]