Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL

GraphQL Storefront Mutations

createWishlist

Example Query

1 mutation ExampleMutation($input: CreateWishlistInput) {
2   createWishlist(input: $input) {
3     result {
4       entityId
5       name
6       isPublic
7       token
8       items
9     }
10   }
11 }

Variables

1 {
2   "input": {
3     "name": "example",
4     "isPublic": true,
5     "items": [
6       {
7         "productEntityId": 0,
8         "variantEntityId": 0
9       }
10     ]
11   }
12 }

Example response

1 {
2   "data": {
3     "createWishlist": {
4       "result": {
5         "entityId": 0,
6         "name": "example",
7         "isPublic": true,
8         "token": "example",
9         "items": {
10           "pageInfo": null,
11           "edges": null,
12           "collectionInfo": null
13         }
14       }
15     }
16   }
17 }

Create wishlist

Arguments

inputCreateWishlistInputRequired

Create wishlists input

Returns

an optional CreateWishlistResult

resultWishlist

The newly created wishlist

Was this page helpful?

logout

addWishlistItems