menuCreate

mutation

Requires write_online_store_navigation access scope.

Creates a menu.

Arguments

Anchor to handlehandle • String!required: The menu's handle.
Anchor to itemsitems • [MenuItemCreateInput!]!required: List of the menu's items.
Anchor to titletitle • String!required: The menu's title.

Was this section helpful?

Anchor to MenuCreatePayload returnsMenuCreatePayload returns

Anchor to menumenu • Menu: The created menu.
Anchor to userErrorsuserErrors • [MenuCreateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a menu
menuCreate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation CreateMenu($title: String!, $handle: String!, $items: [MenuItemCreateInput!]!) {
6    menuCreate(title: $title, handle: $handle, items: $items) {
7      menu {
8        id
9        handle
10        items {
11          id
12          title
13          items {
14            id
15            title
16          }
17        }
18      }
19    }
20  }`,
21  {
22    variables: {
23      "title": "Sidebar",
24      "handle": "sidebar",
25      "items": [
26        {
27          "title": "Collections",
28          "type": "COLLECTION",
29          "url": "/collection",
30          "items": [
31            {
32              "title": "Bestsellers",
33              "type": "COLLECTION",
34              "resourceId": "gid://shopify/Collection/1007901140",
35              "url": "/collection/bestsellers/new",
36              "tags": [
37                "new"
38              ],
39              "items": []
40            }
41          ]
42        },
43        {
44          "title": "Products",
45          "type": "CATALOG",
46          "url": "/collections/all",
47          "items": []
48        },
49        {
50          "title": "About us",
51          "type": "PAGE",
52          "resourceId": "gid://shopify/Page/905192165",
53          "url": "/pages/about-us",
54          "items": []
55        }
56      ]
57    },
58  },
59);
60
61const data = await response.json();
62

mutation CreateMenu($title: String!, $handle: String!, $items: [MenuItemCreateInput!]!) {
  menuCreate(title: $title, handle: $handle, items: $items) {
    menu {
      id
      handle
      items {
        id
        title
        items {
          id
          title
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CreateMenu($title: String!, $handle: String!, $items: [MenuItemCreateInput!]!) { menuCreate(title: $title, handle: $handle, items: $items) { menu { id handle items { id title items { id title } } } } }",
 "variables": {
    "title": "Sidebar",
    "handle": "sidebar",
    "items": [
      {
        "title": "Collections",
        "type": "COLLECTION",
        "url": "/collection",
        "items": [
          {
            "title": "Bestsellers",
            "type": "COLLECTION",
            "resourceId": "gid://shopify/Collection/1007901140",
            "url": "/collection/bestsellers/new",
            "tags": [
              "new"
            ],
            "items": []
          }
        ]
      },
      {
        "title": "Products",
        "type": "CATALOG",
        "url": "/collections/all",
        "items": []
      },
      {
        "title": "About us",
        "type": "PAGE",
        "resourceId": "gid://shopify/Page/905192165",
        "url": "/pages/about-us",
        "items": []
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation CreateMenu($title: String!, $handle: String!, $items: [MenuItemCreateInput!]!) {
    menuCreate(title: $title, handle: $handle, items: $items) {
      menu {
        id
        handle
        items {
          id
          title
          items {
            id
            title
          }
        }
      }
    }
  }`,
  {
    variables: {
      "title": "Sidebar",
      "handle": "sidebar",
      "items": [
        {
          "title": "Collections",
          "type": "COLLECTION",
          "url": "/collection",
          "items": [
            {
              "title": "Bestsellers",
              "type": "COLLECTION",
              "resourceId": "gid://shopify/Collection/1007901140",
              "url": "/collection/bestsellers/new",
              "tags": [
                "new"
              ],
              "items": []
            }
          ]
        },
        {
          "title": "Products",
          "type": "CATALOG",
          "url": "/collections/all",
          "items": []
        },
        {
          "title": "About us",
          "type": "PAGE",
          "resourceId": "gid://shopify/Page/905192165",
          "url": "/pages/about-us",
          "items": []
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CreateMenu($title: String!, $handle: String!, $items: [MenuItemCreateInput!]!) {
      menuCreate(title: $title, handle: $handle, items: $items) {
        menu {
          id
          handle
          items {
            id
            title
            items {
              id
              title
            }
          }
        }
      }
    }`,
    "variables": {
      "title": "Sidebar",
      "handle": "sidebar",
      "items": [
        {
          "title": "Collections",
          "type": "COLLECTION",
          "url": "/collection",
          "items": [
            {
              "title": "Bestsellers",
              "type": "COLLECTION",
              "resourceId": "gid://shopify/Collection/1007901140",
              "url": "/collection/bestsellers/new",
              "tags": [
                "new"
              ],
              "items": []
            }
          ]
        },
        {
          "title": "Products",
          "type": "CATALOG",
          "url": "/collections/all",
          "items": []
        },
        {
          "title": "About us",
          "type": "PAGE",
          "resourceId": "gid://shopify/Page/905192165",
          "url": "/pages/about-us",
          "items": []
        }
      ]
    },
  },
});

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 CreateMenu($title: String!, $handle: String!, $items: [MenuItemCreateInput!]!) {
    menuCreate(title: $title, handle: $handle, items: $items) {
      menu {
        id
        handle
        items {
          id
          title
          items {
            id
            title
          }
        }
      }
    }
  }
QUERY

variables = {
  "title": "Sidebar",
  "handle": "sidebar",
  "items": [{"title"=>"Collections", "type"=>"COLLECTION", "url"=>"/collection", "items"=>[{"title"=>"Bestsellers", "type"=>"COLLECTION", "resourceId"=>"gid://shopify/Collection/1007901140", "url"=>"/collection/bestsellers/new", "tags"=>["new"], "items"=>[]}]}, {"title"=>"Products", "type"=>"CATALOG", "url"=>"/collections/all", "items"=>[]}, {"title"=>"About us", "type"=>"PAGE", "resourceId"=>"gid://shopify/Page/905192165", "url"=>"/pages/about-us", "items"=>[]}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "title": "Sidebar",
3  "handle": "sidebar",
4  "items": [
5    {
6      "title": "Collections",
7      "type": "COLLECTION",
8      "url": "/collection",
9      "items": [
10        {
11          "title": "Bestsellers",
12          "type": "COLLECTION",
13          "resourceId": "gid://shopify/Collection/1007901140",
14          "url": "/collection/bestsellers/new",
15          "tags": [
16            "new"
17          ],
18          "items": []
19        }
20      ]
21    },
22    {
23      "title": "Products",
24      "type": "CATALOG",
25      "url": "/collections/all",
26      "items": []
27    },
28    {
29      "title": "About us",
30      "type": "PAGE",
31      "resourceId": "gid://shopify/Page/905192165",
32      "url": "/pages/about-us",
33      "items": []
34    }
35  ]
36}

Response

JSON

1{
2  "menuCreate": {
3    "menu": null
4  }
5}