Docs/E-Commerce/Magento 2 Integration

Magento 2 Integration

The Magento 2 integration uses a downloadable Magento module that handles both the chat widget injection and the API bridge. The module creates an OAuth 1.0 integration in your Magento store — you copy four credential values into AIChatVault to complete the connection.

Step 1 — Download and install the Magento module

Download the module

On the Magento integration page in AIChatVault, click Download Module. This downloads a zip file containing the AIChatVault Magento 2 extension.

Install the module

Upload the module to your Magento installation. You can do this via Composer (recommended for production) or by copying the files manually to app/code/AiChatVault/Chatbot/.

Enable and run setup

Run the following commands in your Magento root:

•php bin/magento module:enable AiChatVault_Chatbot
•php bin/magento setup:upgrade
•php bin/magento cache:flush

Verify installation

Log in to Magento Admin and navigate to System → Extensions → Integrations. You should see an "AIChatVault" integration entry.

Step 2 — Activate the Magento integration and copy credentials

Open the AIChatVault integration in Magento Admin

Go to System → Extensions → Integrations. Find the AIChatVault entry and click Activate.

Allow API access

Review the requested API resources and click Allow. Magento generates four OAuth credentials.

Copy all four credentials

Copy the Consumer Key, Consumer Secret, Access Token, and Access Token Secret. You will need all four.

Step 3 — Enter credentials in AIChatVault

Open Integrations → Magento

In your agent, go to the Magento integration page.

Enter your store URL and credentials

Paste your Magento store's base URL (e.g. https://yourstore.com) and all four OAuth credentials.

Click Connect

AIChatVault verifies the credentials and starts a background product sync. The integration page shows a Connected status.

Available actions

Action	Description
Product Search & Recommendations	Searches the Magento catalogue and shows product cards with images, prices, and Add to Cart links.
Order Status Lookup	Retrieves order status, tracking info, and purchase history by order number.
View Cart	Displays the customer's current cart contents, quantities, and totals.
Browse Categories	Browses Magento categories to help the AI find relevant products when keyword search returns no results.
Update Customer Profile	Lets signed-in customers update their name or email through chat.
Update Billing Address	Lets signed-in customers add or update billing addresses through natural conversation.

Widget injection

The installed Magento module automatically injects the AIChatVault widget on all storefront pages. No manual theme editing is needed. The module reads your agent's slug and loads the correct widget configuration.

Product sync

A product sync runs automatically when you first connect. The integration page shows the synced product count and last sync timestamp. Click Sync Products to trigger a manual sync after catalogue updates.

Disconnecting Magento

Clicking Disconnect in AIChatVault removes the stored credentials and clears synced products from the knowledge base. To also remove the widget from your store, disable or uninstall the Magento module via php bin/magento module:disable AiChatVault_Chatbot.

⚠️

Magento's REST API requires HTTPS with a valid SSL certificate. HTTP-only installs and self-signed certificates will cause connection failures. Ensure your Magento base URL is set to HTTPS in Stores → Configuration → General → Web.

WooCommerce

OpenCart

Was this page helpful?