Create Wishlist Item
About
The createWishlist mutation adds a product to the authenticated customer's wishlist. Use this mutation to:
- Add products to the wishlist from product pages
- Implement "Add to Wishlist" buttons and heart icons
- Save products for later purchase
- Build wishlist flows programmatically
The customer is automatically detected from the Bearer token — no customer ID is needed in the input.
Authentication
This mutation requires customer authentication:
- Authenticated customers: Provide a valid customer authentication token in the
Authorizationheader. Obtain this token via the Customer Login API.
Authorization: Bearer <accessToken>Arguments
| Argument | Type | Description |
|---|---|---|
productId | Int | The ID of the product to add to the wishlist. |
clientMutationId | String | Optional client-side mutation identifier for tracking. |
Possible Returns
| Field | Type | Description |
|---|---|---|
wishlist | Wishlist! | The newly created wishlist item. |
wishlist.id | ID! | IRI identifier (e.g. /api/shop/wishlists/70). |
wishlist._id | Int! | Numeric identifier. |
wishlist.product | Product! | The associated product with id, name, price. |
wishlist.createdAt | String | Timestamp when the item was added. |

