GraphQL

Wishlist supports accessing Item and List objects via GraphQL. Be sure to read about Craft's GraphQL support (opens new window).

Linked Element Permissions

The schema must permit both the wishlist list type and the linked element’s section, volume, product type or other supported scope. Site and lifecycle permissions also apply. When a linked element is unavailable to the schema, the wishlist item remains in an ordinary query, but its title, elementId, elementClass and element fields return null. Use the wishlist item’s own id and listId to show an unavailable-item placeholder.

Queries using title, search, elementId or elementClass, or sorting by linked-element metadata, return only items whose linked elements the schema can read. This restriction is applied before limit and offset, including for nested list items queries. These queries need additional permission checks over matching items, so prefer a specific listId when searching within one wishlist. Ordinary item ordering, such as orderBy: "id ASC", retains unavailable-item placeholders.

Lists

Example

{
    wishlists (userId: 1) {
        title

        items {
            title
        }
    }
}

{
    "data": {
        "wishlists": [
            {
                "title": "Wishlist",
                "items": [
                    {
                        "title": "Some Entry"
                    }
                ]
            },
            {
                "title": "Favourites",
                "items": []
            }
        ]
    }
}

The wishlists Query

This query is used to query for lists.

The ListInterface Interface

This is the interface implemented by all lists.

Items

Example

{
    wishlistItems (listId: 4562, limit: 1) {
        element {
            id
            title
        }
    }
}

{
    "data": {
        "wishlistItems": [
            {
                "element": {
                    "id": "14931",
                    "title": "Some Entry"
                }
            },
        ]
    }
}

The wishlistItems Query

This query is used to query for items.

The ItemInterface Interface

This is the interface implemented by all items.