Alokai

addProductToWishList

Add products to wishlist

Signature

declare function addProductToWishList(
	context: Context,
	input: MutationAddProductsToWishlistArgs,
	customQuery?: CustomQuery,
	customHeaders?: CustomHeaders
): Promise<FetchResult<AddProductsToWishlistMutation>>;

Parameters

NameRequiredTypeDescription
contextRequiredContext
inputRequiredMutationAddProductsToWishlistArgs
customQueryOptionalCustomQuery
customHeadersOptionalCustomHeaders

Referenced Types

Examples

import { sdk } from '~/sdk.config.ts';

const wishlist = await sdk.magento.addProductToWishList({
  // Wishlist ID
  id: '258',
  // Products to add to wishlist with given ID
  items: [{quantity: 1, sku: 'WSH12'}]
});

Creating a custom GraphQL query for searching categories

module.exports = {
  integrations: {
    magento: {
      customQueries: {
        'add-product-to-wishlist-custom-query': ({ variables, metadata }) => ({
          variables,
          query: `
            mutation addProductsToWishlist($id: ID!, $items: [WishlistItemInput!]!) {
              addProductsToWishlist(wishlistId: $id, wishlistItems: $items) {
                wishlist {
                  ${metadata.fields}
                }
              }
            }`
        }),
      },
    }
  }
}

Using a custom GraphQL query (mutation) to add products to wishlist

import { sdk } from '~/sdk.config.ts';
const customQuery = {
   addProductsToWishList: 'add-product-to-wishlist-custom-query',
   metadata: {
     fields: 'id items_count'
   }
};

const result = await sdk.magento.addProductToWishList({
 id: '258',
 items: [{ quantity: 1, sku: '258'}]
}, customQuery);

// Returned wishlist will contain only the fields specified in the custom query.

On this page