WishlistItemInterface attributes and implementations

WishlistItemInterface provides details about items in a wish list. It has the following implementations:

• BundleWishlistItem
• ConfigurableWishlistItem
• DownloadableWishlistItem
• GiftCardWishlistItem
• GroupedProductWishlistItem
• SimpleWishlistItem
• VirtualWishlistItem

Attributes

The WishlistItemInterface contains the following attributes.

Implementations

BundleWishlistItem attributes

The BundleWishlistItem object defines the following bundle-product specific attribute:

ConfigurableWishlistItem attributes

The ConfigurableWishlistItem object defines the following attributes that are specific to configurable products:

DownloadableWishlistItem attributes

The DownloadableWishlistItem object defines the following attributes that are specific to downloadable products:

GiftCardWishlistItem attributes

The GiftCardWishlistItem object defines the following gift card-specific attribute:

GiftCardOptions attributes

The GiftCardOptions object provides details about a gift card. All attributes are optional for a wish list.

GroupedProductWishlistItem attributes

The GroupedProductWishlistItem data type does not provide additional attributes to the WishlistItemInterface.

SimpleWishlistItem attributes

The SimpleWishlistItem data type does not provide additional attributes to the WishlistItemInterface.

VirtualWishlistItem attributes

The VirtualWishlistItem data type does not provide additional attributes to the WishlistItemInterface.

Example usage

The following mutation adds a downloadable product to a wish list and returns detailed information about the product.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
mutation {
  addProductsToWishlist(
    wishlistId: 3,
    wishlistItems: [
      {
        sku: "240-LV06"
        quantity: 1
      }
    ]
) {
    user_errors {
      code
      message
    }
    wishlist {
      id
      sharing_code
      items_count
      updated_at
      items_v2 {
        uid
        quantity
        added_at
        ... on DownloadableWishlistItem {
          links_v2 {
            uid
            title
            sample_url
          }
          samples {
            title
            sample_url
          }
        }
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "data": {
    "addProductsToWishlist": {
      "user_errors": [],
      "wishlist": {
        "id": "3",
        "sharing_code": "cVeOljNmNKm0e1jRFj7PRMyBXrpu88Sf",
        "items_count": 1,
        "updated_at": "2020-11-12 03:01:46",
        "items_v2": [
          {
            "uid": "MTQ=",
            "quantity": 1,
            "added_at": "2020-11-12 03:01:46",
            "links_v2": [
              {
                "uid": "ZG93bmxvYWRhYmxlLzM=",
                "title": "Yoga Adventure",
                "sample_url": "http://example.com/downloadable/download/linkSample/link_id/3/"
              }
            ],
            "samples": [
              {
                "title": "Trailer #1",
                "sample_url": "http://example.com/downloadable/download/sample/sample_id/7/"
              },
              {
                "title": "Trailer #2",
                "sample_url": "http://example.com/downloadable/download/sample/sample_id/8/"
              },
              {
                "title": "Trailer #3",
                "sample_url": "http://example.com/downloadable/download/sample/sample_id/9/"
              }
            ]
          }
        ]
      }
    }
  }
}