Add AI Search to your E-commerce Store

Why AI Search for E-commerce

AI-powered search can significantly enhance the shopping experience on your e-commerce site by providing more accurate and relevant product results, understanding natural language queries, and even offering personalized recommendations.

Get an API key

Go to the yoursearchbox Dashboard
Select your project under Projects
Go to the Integrations tab
Click on Create integration
Select E-commerce
Provide a Name and Store URL for the integration
Click on Create
Click the Example < /> button to get your API key and view suggested settings

Add the Search Widget to Your Store

The method to add the search widget may vary depending on your e-commerce platform. Here's a general approach:

Access your e-commerce platform's admin panel
Navigate to the theme editor or custom code section
Locate the area where you want to add the search bar (usually in the header)
Add a container for the search widget

Example:

Initialize the widget

Next, under the Tools tab open Head & Footer Code option. Add the code below to the HEAD Code section:

<script
  id="yoursearchbar-script"
  src="https://unpkg.com/@yoursearchbar/[email protected]/dist/embed.js"
  type="module"
  defer
></script>
 
<script defer>
  const yoursearchbarScript = document.getElementById("yoursearchbar-script");
 
  // configure and initialize the widget
  const addyoursearchbarWidget = () => {
    const yoursearchbarWidget = yoursearchbar().embed({
      componentType: "SearchBar",
      targetElement: document.getElementById("yoursearchbar"),
      properties: {
        baseSettings: {
          apiKey: "yoursearchbar_API_KEY", // required
          integrationId: "yoursearchbar_INTEGRATION_ID", // required
          organizationId: "yoursearchbar_ORGANIZATION_ID", // required
          primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
          organizationDisplayName: "yoursearchbar",
          // ...optional settings
          theme: {
            stylesheetUrls: ["/path/to/stylesheets"], // optional
            // ...optional settings
          },
        },
        modalSettings: {
          // optional settings
        },
        searchSettings: {
          // optional settings
        },
        aiChatSettings: {
          // optional settings
          botAvatarSrcUrl: "https://mydomain.com/mylogo", // use your own bot avatar
          quickQuestions: [
            "Example question 1?",
            "Example question 2?",
            "Example question 3?",
          ],
        },
      },
    });
  };
 
  yoursearchbarScript.addEventListener("load", () => {
    if (document.body) addyoursearchbarWidget(); // initialize the widget
  });
</script>

Save Custom Code

Click on the "Save Changes" button.
Navigate to your web application to ensure the widget is installed correctly.

For a full list of customizations, please refer to the Chat Button documentation.

Chat Button Chat Button