addProductsToWishlist mutation

The addProductsToWishlist mutation adds one or more products to the specified wish list. This mutation supports all product types.

In Magento Open Source, customers can have only one wish list. In Adobe Commerce, customers can have multiple wish lists.

This mutation requires a valid customer authentication token.

Syntax

Copy
`mutation {
  addProductsToWishlist(
    wishlistId: ID!,
    wishlistItems: [WishlistItemInput!]!
  ){
  AddProductsToWishlistOutput
  }
}
Copied to your clipboard
`mutation {
  addProductsToWishlist(
    wishlistId: ID!,
    wishlistItems: [WishlistItemInput!]!
  ){
  AddProductsToWishlistOutput
  }
}

Reference

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

Example usage

The following example adds a simple product (24-MB01), a configurable product (WJ01-M-Red), and a bundle product (24-WG080) to the customer's wish list. The SKU WG-09 is invalid, and error information is returned in the user_errors object.

To determine the value of the wishlistId attribute, run the customer query and check the value of wishlist.id in the response.

Request:

Copy
mutation {
  addProductsToWishlist(
    wishlistId: 4
    wishlistItems: [
      {
        sku: "24-MB01"
        quantity: 1
      }
      {
        sku: "WG-09"
        quantity: 1
        }
      {
        parent_sku: "WJ01"
        sku: "WJ01-M-Red"
        quantity: 1
      }
      {
        sku: "24-WG080"
        quantity: 1
        selected_options: [
          "YnVuZGxlLzEvMS8x"
          "YnVuZGxlLzIvNC8x"
          "YnVuZGxlLzMvNy8x"
          "YnVuZGxlLzQvOC8x"
        ]
      }
    ]
  ) {
    wishlist {
      id
      items_count
      items_v2 (currentPage: 1, pageSize: 8 ) {
        items {
          id
          quantity
          ... on BundleWishlistItem {
            bundle_options {
              values {
                id
                label
                quantity
              }
            }
          }
          product {
            uid
            name
            sku
            price_range {
              minimum_price {
                regular_price {
                  currency
                  value
                }
              }
              maximum_price {
                regular_price {
                  currency
                  value
                }
              }
            }
          }
        }
      }
    }
    user_errors {
      code
      message
    }
  }
}
Copied to your clipboard
mutation {
  addProductsToWishlist(
    wishlistId: 4
    wishlistItems: [
      {
        sku: "24-MB01"
        quantity: 1
      }
      {
        sku: "WG-09"
        quantity: 1
        }
      {
        parent_sku: "WJ01"
        sku: "WJ01-M-Red"
        quantity: 1
      }
      {
        sku: "24-WG080"
        quantity: 1
        selected_options: [
          "YnVuZGxlLzEvMS8x"
          "YnVuZGxlLzIvNC8x"
          "YnVuZGxlLzMvNy8x"
          "YnVuZGxlLzQvOC8x"
        ]
      }
    ]
  ) {
    wishlist {
      id
      items_count
      items_v2 (currentPage: 1, pageSize: 8 ) {
        items {
          id
          quantity
          ... on BundleWishlistItem {
            bundle_options {
              values {
                id
                label
                quantity
              }
            }
          }
          product {
            uid
            name
            sku
            price_range {
              minimum_price {
                regular_price {
                  currency
                  value
                }
              }
              maximum_price {
                regular_price {
                  currency
                  value
                }
              }
            }
          }
        }
      }
    }
    user_errors {
      code
      message
    }
  }
}

Response:

Copy
{
  "data": {
    "addProductsToWishlist": {
      "wishlist": {
        "id": "4",
        "items_count": 3,
        "items_v2": {
          "items": [
            {
              "id": "20",
              "quantity": 1,
              "product": {
                "uid": "MQ==",
                "name": "Joust Duffle Bag",
                "sku": "24-MB01",
                "price_range": {
                  "minimum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 34
                    }
                  },
                  "maximum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 34
                    }
                  }
                }
              }
            },
            {
              "id": "21",
              "quantity": 1,
              "product": {
                "uid": "MTIyNg==",
                "name": "Stellar Solar Jacket",
                "sku": "WJ01",
                "price_range": {
                  "minimum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 75
                    }
                  },
                  "maximum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 75
                    }
                  }
                }
              }
            },
            {
              "id": "22",
              "quantity": 1,
              "bundle_options": [
                {
                  "values": [
                    {
                      "id": 1,
                      "label": "Sprite Stasis Ball 55 cm",
                      "quantity": 1
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "id": 4,
                      "label": "Sprite Foam Yoga Brick",
                      "quantity": 1
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "id": 7,
                      "label": "Sprite Yoga Strap 10 foot",
                      "quantity": 1
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "id": 8,
                      "label": "Sprite Foam Roller",
                      "quantity": 1
                    }
                  ]
                }
              ],
              "product": {
                "uid": "NTI=",
                "name": "Sprite Yoga Companion Kit",
                "sku": "24-WG080",
                "price_range": {
                  "minimum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 61
                    }
                  },
                  "maximum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 77
                    }
                  }
                }
              }
            }
          ]
        }
      },
      "user_errors": [
        {
          "code": "PRODUCT_NOT_FOUND",
          "message": "Could not find a product with SKU \"WG-09\""
        }
      ]
    }
  }
}
Copied to your clipboard
{
  "data": {
    "addProductsToWishlist": {
      "wishlist": {
        "id": "4",
        "items_count": 3,
        "items_v2": {
          "items": [
            {
              "id": "20",
              "quantity": 1,
              "product": {
                "uid": "MQ==",
                "name": "Joust Duffle Bag",
                "sku": "24-MB01",
                "price_range": {
                  "minimum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 34
                    }
                  },
                  "maximum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 34
                    }
                  }
                }
              }
            },
            {
              "id": "21",
              "quantity": 1,
              "product": {
                "uid": "MTIyNg==",
                "name": "Stellar Solar Jacket",
                "sku": "WJ01",
                "price_range": {
                  "minimum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 75
                    }
                  },
                  "maximum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 75
                    }
                  }
                }
              }
            },
            {
              "id": "22",
              "quantity": 1,
              "bundle_options": [
                {
                  "values": [
                    {
                      "id": 1,
                      "label": "Sprite Stasis Ball 55 cm",
                      "quantity": 1
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "id": 4,
                      "label": "Sprite Foam Yoga Brick",
                      "quantity": 1
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "id": 7,
                      "label": "Sprite Yoga Strap 10 foot",
                      "quantity": 1
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "id": 8,
                      "label": "Sprite Foam Roller",
                      "quantity": 1
                    }
                  ]
                }
              ],
              "product": {
                "uid": "NTI=",
                "name": "Sprite Yoga Companion Kit",
                "sku": "24-WG080",
                "price_range": {
                  "minimum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 61
                    }
                  },
                  "maximum_price": {
                    "regular_price": {
                      "currency": "USD",
                      "value": 77
                    }
                  }
                }
              }
            }
          ]
        }
      },
      "user_errors": [
        {
          "code": "PRODUCT_NOT_FOUND",
          "message": "Could not find a product with SKU \"WG-09\""
        }
      ]
    }
  }
}

Errors

Last updated 9/7/2023

Was this helpful?

Yes

No