For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Skip to navigation

This page is for Developer.

GraphQL Storefront Mutations

createWishlist

Example Query

mutation ExampleMutation($input: CreateWishlistInput!) {
  wishlist {
    createWishlist(input: $input) {
      result {
        entityId
        name
        isPublic
        token
        items
      }
    }
  }
}

Variables

{
  "input": {
    "name": "example",
    "isPublic": true,
    "items": [
      {
        "productEntityId": 0,
        "variantEntityId": 0
      }
    ]
  }
}

Example response

{
  "data": {
    "wishlist": {
      "createWishlist": {
        "result": {
          "entityId": 0,
          "name": "example",
          "isPublic": true,
          "token": "example",
          "items": {
            "pageInfo": null,
            "edges": null,
            "collectionInfo": null
          }
        }
      }
    }
  }
}

Create wishlist

Arguments

inputCreateWishlistInputRequired

Create wishlists input

Returns

an optional CreateWishlistResult

The newly created wishlist

Was this page helpful?

addWishlistItems

Docs API Reference Learn Community Changelog

- About Our APIs
- Download OpenAPI Specs
REST
GraphQL
MCP
Resources

Developer
Product