ShopAssistConnect a PrestaShop store
Install the ShopAssist module and connect a client's PrestaShop store.
Add the client in the partner portal before you start, with the platform set to PrestaShop. Connecting requires an administrator login for the store's PrestaShop admin.
If the client installs the module themselves, send them the merchant guide at widget.getshopassist.com/prestashop.
What the module provides
| Component | Description | Placement |
|---|---|---|
| Chat widget | Floating chat button and modal, site-wide | Automatic, once the shop is live |
| Add to cart | A size and color picker in the chat, adding to the PrestaShop cart | Automatic |
| Order reporting | Orders that followed a conversation, with their revenue, in the dashboard | Automatic, after Connect |
| Ask ShopAssist | AI-generated question pills under the add-to-cart button | Automatic for products with questions. See Enhance ShopAssist - PrestaShop |
| Compare | Compare button on the product image and on product cards | Once support switches Compare on. See Enhance ShopAssist - PrestaShop |
ShopAssist reads the catalog and the orders through the PrestaShop Webservice, with a read-only key that Connect creates. The module records the chat session on the shopper's cart and copies it onto the order when the order is placed, which is how the dashboard knows which sales came from a conversation.
1. Check the store
| Requirement | Reason |
|---|---|
| PrestaShop 8.0 or newer | The module's minimum version |
Reachable from the internet over HTTPS, including /api | ShopAssist reads the catalog there |
Outbound HTTPS from the web server to api.getshopassist.com | Connect sends the key there |
| Hummingbird, Classic, or a theme based on them | Compare reads their product cards |
Take the store out of maintenance mode before step 3, and open /api to
ShopAssist if a firewall, IP allowlist or basic authentication sits in front of
the store.
2. Install the module
Work in the client's PrestaShop admin.
- Download shopassist.zip. The client card in the portal has the same link under Download module.
- Open Modules → Module Manager and select Upload a module.
- Drag the zip file into the window.
PrestaShop installs the module and shows Module installed! with a Configure button.
3. Connect the store
- Select Configure. Later, the same page is under Modules → Module Manager, next to ShopAssist.
- Select Connect to ShopAssist.
The module turns on the PrestaShop Webservice, creates a key named ShopAssist (read-only catalog) and sends it to ShopAssist with the store's default language and currency. ShopAssist reads one product with the key, then stores it on the client you added.
The page confirms the connection, and the client card in the portal reads Connected.
The key is listed in Advanced Parameters → Webservice, with View (GET) and
Fast view (HEAD) on these resources:
| Resources | Used for |
|---|---|
| products, combinations, product_options, product_option_values, product_features, product_feature_values, stock_availables, categories, images | The catalog the assistant answers from, including each product's data sheet |
| orders, order_states, currencies | Order reporting: totals, status and currency |
| shopassist_attributions | Which orders came from a conversation. The module adds this resource |
Selecting Connect again reuses the same key and refreshes it at ShopAssist.
Status line
The top of the ShopAssist settings page reflects the shop in ShopAssist.
| Status line | Portal stage | Next step |
|---|---|---|
| Not connected yet. | Created | Step 3 |
| Connected. Waiting for ShopAssist to switch the assistant on. | Connected or Testing | Build and ship the assistant, then Go live |
| Connected and live. | Live | Check the storefront |
Module settings
| Setting | Effect | After install |
|---|---|---|
| Show the assistant | Shows or hides the whole assistant | Yes |
| Question pills on product pages | Shows the questions under the add-to-cart button | Yes |
| Compare buttons | Shows the Compare buttons | Yes |
| API URL, Widget URL | Point the module at ShopAssist. Empty uses the ShopAssist defaults | Empty |
The module reads the language, currency and country from each storefront page, so a store with several languages or currencies works with one install.
Catalog setup
ShopAssist lists every combination of a product, such as each size and color of a t-shirt, as its own entry. Ask support to switch on the variant picker for the shop, and name the attribute groups shoppers choose from, such as size and color. The chat then shows each product once, with a Choose options button.
Customizable products link to their product page, where shoppers fill in the customization form and add them to the cart.
Check the store
Once the shop is live:
- Open the storefront in a private window. A round chat button sits at the bottom of the page.
- Ask for a product. The answer shows product cards with the store's prices, including discounts.
- Select Choose options on a card, pick a size and a color, and add it. The cart counter in the header goes up, and the PrestaShop cart lists the item with those options.
- Place a test order from that cart. It appears in the client dashboard as an AI-attributed order after the next order sync.
To read the widget status from the command line, run:
curl -H "X-Shop-Domain: client-shop.com" \
https://api.getshopassist.com/api/widget/settings"pluginEnabled": true means that the shop is live.
Uninstall
Open Modules → Module Manager, open the menu next to ShopAssist, and select Uninstall. The chat button goes away, and the module deletes its Webservice key and its attribution records. The client, its settings, its conversations and the orders already synced stay in ShopAssist. To pause the widget instead, set Show the assistant to No.
Troubleshooting
| Symptom | Cause | Resolution |
|---|---|---|
| "ShopAssist could not read your catalog with the Webservice key." | The web server drops the Authorization header before PHP, which is common with PHP-FPM and CGI hosting | In Shop Parameters → Traffic & SEO, set Friendly URL to Yes and save, which rewrites .htaccess. Or ask the host to pass HTTP_AUTHORIZATION to PHP. Then select Connect again |
| "ShopAssist could not reach your store." | A firewall, IP allowlist or basic authentication sits in front of /api | Open /api over HTTPS to ShopAssist, then select Connect again |
| "Your bot protection blocked ShopAssist." | A bot service in front of the store refused ShopAssist | Email support with the name of the service |
| "This domain is already registered with ShopAssist on another platform." | The domain was registered as another platform, for example before a migration | Email support with the domain |
| Status line reads ShopAssist is unreachable right now | The server blocks outbound HTTPS | Allow outbound HTTPS to api.getshopassist.com |
| Client card stays on Created after Connect | The domain in the portal differs from the store's own domain, for example a staging domain | Email support with both domains |
| Connected, but no chat button | The shop is waiting for go-live, or Show the assistant is No | Take the shop live, then check the setting |
| Orders sync, none attributed | The key predates order reporting, so it lacks shopassist_attributions | Select Connect again. The module adds the new permissions to its key |
| An add from the chat asks for required fields | The product is customizable | Shoppers add it from its product page |
For anything else, email support@getshopassist.com with the shop domain, the PrestaShop version, the theme, the step reached, and the message on the ShopAssist settings page.
Next
Build and ship the assistant. The remaining work is the same on every platform. Once the shop is live, set up the question pills and Compare with Enhance ShopAssist - PrestaShop.
Last updated on