Wishify-node-api NPM

Wishify API

Wishify API is a Node.js package designed to work with the Wishify Shopify app. This package allows you to interact with customer wishlists by fetching, adding, and removing items, as well as customizing the wishlist page for your Shopify store.

Installation

You can install the package using npm or Yarn:

npm install wishify-api
# or
yarn add wishify-api

Usage

To use the wishify-api, you need to initialize it with your Shopify store name and the public access key. Here's how to get started:

Initialization

import WishifyApi from 'wishify-api';

// Initialize the API with your store name and public access key
const api = new WishifyApi('your-store-name', 'your-public-access-key');

Fetch Customer Wishlist

To fetch a customer's wishlist, use the getCustomerWishlist method:

const customerId = 'customer-id';
const wishlistData = await api.getCustomerWishlist(customerId);
console.log(wishlistData);

Add Item to Wishlist

To add an item to a customer's wishlist, use the addItemToWishlist method:

const productId = 'product-id';
await api.addItemToWishlist(customerId, productId);
console.log(`Item with ID ${productId} added to wishlist.`);

Remove Item from Wishlist

To remove an item from a customer's wishlist, use the removeItemFromWishlist method:

await api.removeItemFromWishlist(customerId, productId);
console.log(`Item with ID ${productId} removed from wishlist.`);

Example

Here's a complete example of how to use the wishify-api:

import WishifyApi from 'wishify-api';

const api = new WishifyApi('your-store-name', 'your-public-access-key');

const customerId = 'customer-id';

async function manageWishlist() {
  try {
    // Fetch wishlist
    const wishlist = await api.getCustomerWishlist(customerId);
    console.log('Current Wishlist:', wishlist);
    
    const productIdToAdd = 'new-product-id';
    
    // Add item to wishlist
    await api.addItemToWishlist(customerId, productIdToAdd);
    
    // Remove item from wishlist
    await api.removeItemFromWishlist(customerId, 'product-id-to-remove');
    
    console.log('Updated Wishlist:', await api.getCustomerWishlist(customerId));
  } catch (error) {
    console.error('Error managing wishlist:', error);
  }
}

manageWishlist();