> ## Documentation Index
> Fetch the complete documentation index at: https://chatbase.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Shopify Actions
> Help customers browse products, track orders, manage their cart, and update their account through your AI agent
## Overview
Shopify Actions enable your AI agent to provide comprehensive e-commerce support directly within the chat interface. These actions give your agent access to your store's product catalog, order information, and customer data, allowing it to assist shoppers throughout their entire journey.
**Prerequisite:** Before using Shopify Actions, you must [set up the Shopify integration](/user-guides/integrations/shopify) with your Chatbase account.
## Available Shopify Actions
### 1. Get Products
Search and display products from your Shopify catalog. Customers can browse by category, filter by criteria, search for specific items, and add products directly to their cart.
Helping customers discover products, answering questions about inventory, comparing items, and facilitating add-to-cart actions.
**Common Use Cases:**
* "Show me red dresses under \$50"
* "What laptops do you have in stock?"
**Note:** Adding products to the cart only works when the app is embedded in your Shopify store. It will not work in the Playground.
#### Cart Update Events
When a customer adds a product to their cart through the chat widget, Chatbase dispatches custom DOM events so your theme can react accordingly (e.g., updating the cart icon count). The following events are fired:
```js theme={null}
document.dispatchEvent(new CustomEvent('cart:updated', { detail: { newCart } }));
document.dispatchEvent(new CustomEvent('cart-update', { detail: { newCart } }));
document.dispatchEvent(new CustomEvent('cart:update', { detail: { newCart } }));
```
You can listen to any of these events in your theme's JavaScript to keep the cart UI **in sync**:
```js theme={null}
document.addEventListener('cart:updated', (event) => {
const cart = event.detail.newCart;
// Update your theme's cart count, e.g.:
document.querySelector('.cart-count').textContent = cart.item_count;
});
```
Multiple event names are dispatched to ensure compatibility across different Shopify themes. You only need to listen to one of them.
#### How Product Sync Works
To sync your catalog, expand the **Products** accordion and click **Sync** or **Sync and Enable Action**. Chatbase will then retrieve all products from your Shopify store. After the initial import, Chatbase automatically listens for changes—whenever a product is added, updated, or deleted in your store, the data syncs in real time. This ensures your agent always has access to up-to-date product information. When you delete the action, Chatbase automatically removes its stored product data and stops syncing future updates.
#### Setup Instructions
Go to your [Chatbase dashboard](https://www.chatbase.co/dashboard/) and select the agent connected to your Shopify store. Click **Actions** at the top of the page.
Click **Create Action** and choose **Shopify show product**.
**Action Name:** Enter a descriptive name for the action (e.g., "Search Products").
**When to use:** Provide clear instructions for when the AI should trigger this action. For example:
* Use this action when the user asks about products, inventory, or availability
* Use this action when the user wants to browse or search for items
* Use this action when the user asks to add something to their cart
Expand the **Products** accordion and click **Sync** to import your catalog, or click **Sync and Enable Action** to sync and enable the action in one step. The initial sync may take a few minutes depending on your catalog size.
If you clicked **Sync** in the previous step, click **Save** and ensure the action is toggled to **Enabled**.
Test the action by asking your agent product-related questions to verify it returns accurate results.
***
### 2. Get Orders
Retrieve order information for customers. Customers can check order status, view their purchase history, and get details about specific orders using various filters.
Answering order status inquiries, providing tracking information, displaying purchase history, and helping customers find specific order details.
**Common Use Cases:**
* "Where is my order?"
* "Show me my recent orders"
* "What's the status of order #1234?"
* "When will my package arrive?"
**Order status in the widget:** The widget pulls order status directly from Shopify, so it reflects the latest information Shopify has available on the order status page. Shipped orders appear as "**On its way**". To display delivery confirmation, ensure your store uses a trackable carrier (USPS, UPS, FedEx, etc.) or a third-party app that provides delivery updates to Shopify.
#### Setup Instructions
Go to your [Chatbase dashboard](https://www.chatbase.co/dashboard/) and select the agent connected to your Shopify store. Click **Actions** at the top of the page.
Click **Create Action** and choose **Shopify show order**.
**Action Name:** Enter a descriptive name for the action (e.g., "Order Lookup").
**When to use:** Provide clear instructions for when the AI should trigger this action. For example:
* Use this action when the user asks about their order status
* Use this action when the user wants to track a shipment
* Use this action when the user asks about their purchase history
* Use this action when the user provides an order number
Click **Save** and ensure the action is toggled to **Enabled**.
Test the action by asking your agent about order status to verify it retrieves the correct information.
**This action cannot be tested in the Action Preview on the dashboard, as it requires the user to be authenticated in order to work properly.**
***
### 3. Get Cart
Display the current contents of a customer's shopping cart, including items, quantities, prices, and totals.
Showing customers what's in their cart, displaying cart totals, and helping customers review items before checkout.
**Common Use Cases:**
* "What's in my cart?"
* "Show me my cart total"
* "How many items are in my cart?"
* "What did I add to my cart?"
**Note:** Retrieving the cart only works when the app is embedded in your Shopify store. It will not work in the Playground.
#### Setup Instructions
Go to your [Chatbase dashboard](https://www.chatbase.co/dashboard/) and select the agent connected to your Shopify store. Click **Actions** at the top of the page.
Click **Create Action** and choose **Shopify get cart**.
**Action Name:** Enter a descriptive name for the action (e.g., "View Cart").
**When to use:** Provide clear instructions for when the AI should trigger this action. For example:
* Use this action when the user asks about their cart contents
* Use this action when the user wants to see their cart total
* Use this action when the user asks what items they've added
Click **Save** and ensure the action is toggled to **Enabled**.
Test the action by asking your agent to show cart contents.
**This action cannot be tested in the Action Preview on the dashboard, as it requires the user to be authenticated in order to work properly.**
***
### 4. Update Profile
Enable customers to modify their account profile information through the agent.
Account management, updating contact information, and helping customers keep their profile current.
**Common Use Cases:**
* "Update my email address"
* "Change my phone number"
* "Update my account information"
#### Setup Instructions
Go to your [Chatbase dashboard](https://www.chatbase.co/dashboard/) and select the agent connected to your Shopify store. Click **Actions** at the top of the page.
Click **Create Action** and choose **Shopify update profile**.
**Action Name:** Enter a descriptive name for the action (e.g., "Update Profile").
**When to use:** Provide clear instructions for when the AI should trigger this action. For example:
* Use this action when the user wants to update their profile information
* Use this action when the user asks to change their email or phone number
* Use this action when the user wants to modify their account details
Click **Save** and ensure the action is toggled to **Enabled**.
Test the action by asking your agent to update profile information.
**This action cannot be tested in the Action Preview on the dashboard, as it requires the user to be authenticated in order to work properly.**
***
### 5. Update Billing Address
Allow customers to add new billing addresses or update existing ones directly through the chat interface.
Self-service address updates, helping customers correct billing information, and streamlining account management.
**Common Use Cases:**
* "Update my billing address"
* "Change my payment address"
* "I moved and need to update my address"
* "I want to add a new address and set it as default"
#### Setup Instructions
Go to your [Chatbase dashboard](https://www.chatbase.co/dashboard/) and select the agent connected to your Shopify store. Click **Actions** at the top of the page.
Click **Create Action** and choose **Shopify update address**.
**Action Name:** Enter a descriptive name for the action (e.g., "Update Billing Address").
**When to use:** Provide clear instructions for when the AI should trigger this action. For example:
* Use this action when the user wants to update their billing address
* Use this action when the user mentions they moved or changed addresses
* Use this action when the user asks to change their payment address
Click **Save** and ensure the action is toggled to **Enabled**.
Test the action by asking your agent to update a billing address.
**This action cannot be tested in the Action Preview on the dashboard, as it requires the user to be authenticated in order to work properly.**
***
## Best Practices
Write specific "When to use" descriptions to help the AI agent accurately determine when to trigger each action. Include example phrases customers might use.
Test each action with various customer queries before going live. Verify that product searches return accurate results and order lookups display correct information.
Monitor your product sync status regularly. If you notice discrepancies, you can manually trigger a resync from the action settings.
Enable multiple actions together to provide a complete shopping experience. Customers often need to search products, check their cart, and track orders in the same conversation.