ShopAssist for developers
Install the ShopAssist AI shopping assistant on any storefront.
ShopAssist is an AI shopping assistant that answers product questions, recommends items and compares them, inside a chat widget on your storefront.
Shopify and WooCommerce shops install it from the app store or the plugin directory and stop reading here. This site is for every other storefront: a custom frontend, a headless Shopify store on Next.js or Astro, or anything you built yourself.
Install
npm i @shopassist/jsimport ShopAssist from "@shopassist/js";
ShopAssist({ shopDomain: "your-shop.com" });That is the whole install. The widget fetches its appearance, greeting, suggestions and page rules from your ShopAssist dashboard, so there is nothing else to configure in code.
What you need first
Your shop must be registered with ShopAssist and your catalog imported. You get a
shop identifier, which is a domain such as your-shop.com. For a headless
Shopify store the identifier is your *.myshopify.com domain, not the public URL
your shoppers see.
There is no API key and no domain allowlist. The widget is identified by that domain alone.
Pick your storefront
Two packages
@shopassist/js works in any framework and has no dependencies. It loads the
widget from the ShopAssist CDN rather than containing it, so it stays small and
never needs a release when the widget changes.
@shopassist/react adds a provider, hooks and components on top. Use it in a
React app; you do not need it otherwise.
What the widget can do on your storefront
By default product cards link to the product page and the shopper buys through your normal checkout. You can go further:
- Add to your cart from inside the chat.
- Attribute orders back to conversations.
- Show question pills on a product page.
- Compare products side by side.
- Embed the chat in the page instead of a floating button.
Last updated on