createWishlist mutation

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

This mutation requires a valid customer authentication token.

• enable_multiple_wishlists
• magento_wishlist_general_is_enabled
• maximum_number_of_wishlists

Syntax

Copy
mutation {
  createWishlist(input: CreateWishlistInput!) {
    CreateWishlistOutput
  }
}
Copied to your clipboard
mutation {
  createWishlist(input: CreateWishlistInput!) {
    CreateWishlistOutput
  }
}

Reference

The createWishlist reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example creates the My favorites public wish list.

Request:

Copy
mutation {
  createWishlist(input: {
    name: "My favorites"
    visibility: PUBLIC
    }
  ) {
    wishlist {
      id
      name
      visibility
    }
  }
}
Copied to your clipboard
mutation {
  createWishlist(input: {
    name: "My favorites"
    visibility: PUBLIC
    }
  ) {
    wishlist {
      id
      name
      visibility
    }
  }
}

Response:

Copy
{
  "data": {
    "createWishlist": {
      "wishlist": {
        "id": "3",
        "name": "My favorites",
        "visibility": "PUBLIC"
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "createWishlist": {
      "wishlist": {
        "id": "3",
        "name": "My favorites",
        "visibility": "PUBLIC"
      }
    }
  }
}

Last updated 9/7/2023

Was this helpful?

Yes

No