metaobject Definition Createmutation
mutation
2024-07
Requires
write_metaobject_definitions
access scope.
Creates a new metaobject definition.
Arguments
The input fields for creating a metaobject definition.
Was this section helpful?
MetaobjectDefinitionCreatePayload returns
The created metaobject definition.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Examples
Hide code
DescriptionCopy
mutation CreateMetaobjectDefinition($definition: MetaobjectDefinitionCreateInput!) { metaobjectDefinitionCreate(definition: $definition) { metaobjectDefinition { name type fieldDefinitions { name key } } userErrors { field message code } } }
curl -X POST \ https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation CreateMetaobjectDefinition($definition: MetaobjectDefinitionCreateInput!) { metaobjectDefinitionCreate(definition: $definition) { metaobjectDefinition { name type fieldDefinitions { name key } } userErrors { field message code } } }", "variables": { "definition": { "name": "Color swatch", "type": "color-swatch", "fieldDefinitions": [ { "name": "Hex", "key": "hex", "type": "single_line_text_field", "validations": [ { "name": "regex", "value": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" } ] } ] } } }'
const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation CreateMetaobjectDefinition($definition: MetaobjectDefinitionCreateInput!) { metaobjectDefinitionCreate(definition: $definition) { metaobjectDefinition { name type fieldDefinitions { name key } } userErrors { field message code } } }`, { variables: { "definition": { "name": "Color swatch", "type": "color-swatch", "fieldDefinitions": [ { "name": "Hex", "key": "hex", "type": "single_line_text_field", "validations": [ { "name": "regex", "value": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" } ] } ] } }, }, ); const data = await response.json();
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 CreateMetaobjectDefinition($definition: MetaobjectDefinitionCreateInput!) { metaobjectDefinitionCreate(definition: $definition) { metaobjectDefinition { name type fieldDefinitions { name key } } userErrors { field message code } } } QUERY variables = { "definition": { "name": "Color swatch", "type": "color-swatch", "fieldDefinitions": [{"name"=>"Hex", "key"=>"hex", "type"=>"single_line_text_field", "validations"=>[{"name"=>"regex", "value"=>"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"}]}] } } response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation CreateMetaobjectDefinition($definition: MetaobjectDefinitionCreateInput!) { metaobjectDefinitionCreate(definition: $definition) { metaobjectDefinition { name type fieldDefinitions { name key } } userErrors { field message code } } }`, "variables": { "definition": { "name": "Color swatch", "type": "color-swatch", "fieldDefinitions": [ { "name": "Hex", "key": "hex", "type": "single_line_text_field", "validations": [ { "name": "regex", "value": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" } ] } ] } }, }, });
use Shopify\Clients\Graphql; $client = new Graphql("your-development-store.myshopify.com", $accessToken); $query = <<<QUERY mutation CreateMetaobjectDefinition($definition: MetaobjectDefinitionCreateInput!) { metaobjectDefinitionCreate(definition: $definition) { metaobjectDefinition { name type fieldDefinitions { name key } } userErrors { field message code } } } QUERY; $variables = [ "definition" => [ "name" => "Color swatch", "type" => "color-swatch", "fieldDefinitions" => [{"name"=>"Hex", "key"=>"hex", "type"=>"single_line_text_field", "validations"=>[{"name"=>"regex", "value"=>"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"}]}], ], ]; $response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{ "definition": { "name": "Color swatch", "type": "color-swatch", "fieldDefinitions": [ { "name": "Hex", "key": "hex", "type": "single_line_text_field", "validations": [ { "name": "regex", "value": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" } ] } ] } }
Hide code
Response
JSON
{ "metaobjectDefinitionCreate": { "metaobjectDefinition": { "name": "Color swatch", "type": "color-swatch", "fieldDefinitions": [ { "name": "Hex", "key": "hex" } ] }, "userErrors": [] } }