createWishlist mutation

The createWishlist mutation creates a wish list for the logged in customer. Magento Commerce allows customers to have multiple wish lists.

This mutation requires a valid customer authentication token.

Use the storeConfig query with the following attributes to determine whether multiple wish lists are supported:

• enable_multiple_wishlists
• magento_wishlist_general_is_enabled
• maximum_number_of_wishlists

Syntax

1
2
3
4
5
mutation {
  createWishlist(input: CreateWishlistInput!) {
    CreateWishlistOutput
  }
}

Example usage

The following example creates the My favorites public wish list.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
mutation {
  createWishlist(input: {
    name: "My favorites"
    visibility: PUBLIC
    }
  ) {
    wishlist {
      id
      name
      visibility
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
{
  "data": {
    "createWishlist": {
      "wishlist": {
        "id": "3",
        "name": "My favorites",
        "visibility": "PUBLIC"
      }
    }
  }
}

Input attributes

The CreateWishlistInput object requires the following input.

Output attributes

The createWishlist mutation returns the Wishlist object.

The Wishlist object contains all the items in the customer’s wish list.

WishlistItem attributes

The WishlistItem object can contain the following attributes.