Docs
E-Commerce Store
Chat Button

Add AI Chat to your E-commerce Store

Why AI Chat for E-commerce

AI Chat can significantly enhance the customer experience on your e-commerce site by providing instant support, product recommendations, and answering frequently asked questions.

Get an API key

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

Add the Chat Widget to Your Store

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

  1. Open WordPress admin panel
  2. Select the Plugins tab
  3. Open the Add New Plugin section
  4. Install the Head & Footer Code plugin

Initialize the widget

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

<script
  id="yoursearchbox-script"
  src="https://unpkg.com/@yoursearchbox/[email protected]/dist/embed.js"
  type="module"
  defer
></script>
 
<script defer>
  const yoursearchboxScript = document.getElementById("yoursearchbox-script");
 
  // configure and initialize the widget
  const yoursearchboxWidget = () => {
    const yoursearchboxWidget = yoursearchbox().embed({
      componentType: "ChatButton",
      properties: {
        chatButtonType: "PILL",
        baseSettings: {
          apiKey: "yoursearchbox_API_KEY", // required
          integrationId: "yoursearchbox_INTEGRATION_ID", // required
          organizationId: "yoursearchbox_ORGANIZATION_ID", // required
          primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
          organizationDisplayName: "yoursearchbox",
          // ...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?",
          ],
        },
      },
    });
  };
 
  yoursearchboxScript.addEventListener("load", () => {
    if (document.body) yoursearchboxWidget(); // initialize the widget
  });
</script>

Save Custom Code

  1. Click on the "Save Changes" button.
  2. 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.