PrestaShop Setup Guide

Architecture

Emporiqa uses your store catalog as its knowledge base: the module pushes products, combinations, prices, stock and CMS pages over webhooks as you save them, so there is no separate knowledge base you have to write or keep up to date. For anything your shop pages never covered, you can write a page yourself on the Pages screen in the Emporiqa dashboard: a title and the text in your own words, in up to 10 languages on the same page. You write each language yourself, and any of them can carry a link to the same page on your site. The chat answers from it like it answers from any page your shop sent, and a sync never overwrites it. Up to 25 pages per store. On the Products screen you can set up to 50 products to Promoted or Top: the chat shows them first when they match what the shopper asked, Top before Promoted, and never shows them for unrelated questions. A sync never clears it.

The module listens to PrestaShop hooks (actionProductSave, actionObjectCmsUpdateAfter, combination events, order validation, etc.) and sends webhook events to Emporiqa using deferred delivery: events are queued during the request and flushed after the response reaches the browser via register_shutdown_function. Saving a product completes locally; the webhook delivery runs asynchronously after the response.

All translations and channels for a single product or page consolidate into one webhook event. Combinations cascade up: editing a child triggers a parent re-sync so search always sees the full catalog state.

Requirements

Configuration Reference

All settings live at Modules → Emporiqa → Configure. Connection Settings is the main section and is expanded by default. Shops and Languages sit next to it. The sync toggles, order tracking, webhook URL and batch size are collapsed under Advanced. Once connected, a Ready-made rules section shows the Order status address. The configuration page is available in English, French and German.

Connection Settings

Shops and Languages

Advanced Settings

Most stores don't need to change these.

Always-on capabilities

• Cart operations: add, update, remove from inside the chat. The cart badge in your theme's header updates right after the chat adds a product.
• Signed-in shoppers: the chat knows a logged-in customer through a short-lived token it fetches when the chat opens. The token is never written into the page, so a full-page cache cannot hand one customer's identity to another.
• Conversion tracking: chat sessions linked to completed orders for revenue attribution.
• Multi-shop mapping: each PrestaShop shop auto-maps to a slugified channel.

Features

Webhook Payload

Each product or page is sent as a single webhook event containing all languages and channels. Translatable fields are nested by channel and language code.

Product Event

{
  "type": "product.updated",
  "data": {
    "identification_number": "product-42",
    "sku": "product-42",
    "channels": ["my-shop"],
    "names":        {"my-shop": {"en": "Hiking Boots", "fr": "Chaussures de randonnee"}},
    "descriptions": {"my-shop": {"en": "Waterproof leather boots...", "fr": "Bottes en cuir impermeables..."}},
    "links":        {"my-shop": {"en": "https://store.com/hiking-boots", "fr": "https://store.com/fr/chaussures-randonnee"}},
    "categories":   {"my-shop": {"en": ["Footwear > Hiking"], "fr": ["Chaussures > Randonnee"]}},
    "attributes":   {"my-shop": {"en": {"Material": "Leather"}, "fr": {"Material": "Cuir"}}},
    "brands":       {"my-shop": "TrailPeak"},
    "prices":       {"my-shop": [{"currency": "EUR", "current_price": 129.99, "regular_price": 149.99}]},
    "images":       {"my-shop": ["https://store.com/img/boots-front.jpg"]},
    "availability_statuses":  {"my-shop": "available"},
    "stock_quantities":       {"my-shop": 42},
    "min_order_quantities":   {"my-shop": 1},
    "max_order_quantities":   {"my-shop": null},
    "available_for_order": true,
    "condition": "new",
    "is_virtual": false,
    "is_parent": false,
    "parent_sku": null,
    "variation_attributes": {}
  }
}

Field Structure

Customization Hooks

The module dispatches PrestaShop hooks you can listen to from your own module to control sync behavior and modify data before it's sent.

Example: skip inactive products

// In your custom module
public function hookActionEmporiqaShouldSyncProduct($params)
{
    $product = $params['product'];

    if (!$product->active) {
        $params['should_sync'] = false;
    }
}

Order status

The ready-made Order status rule answers "Where is my order?" in the chat. Emporiqa asks your shop through the module's signed order_status endpoint and tells the shopper the status, the order date and, when there is one, the tracking link. On PrestaShop 9.2 the answer includes the tracking numbers from its new shipments, alongside the carrier's tracking number, each with its carrier. Only orders from the shops chosen under Shops and Languages are found. It needs module version 1.3.0 or newer.

What the shopper sees, what your team gets and how to write your own rules: Rules guide.

Set it up

1. In the back office, open Modules → Emporiqa → Configure. Once connected, it shows a Ready-made rules section with the Order status address and a Copy button. If you connected with manual credentials and the section is not there yet, click Test Connection on the Sync tab.
2. Click Open in Emporiqa next to Order status. Your Emporiqa dashboard opens at Settings → Rules with Order status highlighted. Click Add.
3. Click Try it and ask about one of your recent orders. When it answers correctly, click Go live.

If you connected with Connect to Emporiqa, there is nothing to copy: Emporiqa fills in your shop's address itself and checks it with your shop. If it ever asks for the address, paste the Order status address the module shows, which looks like this:

What the shopper gives

• Signed in to your shop: only the order reference (the one in the order confirmation email). The module answers only for that customer's own orders.
• Guest: the order reference (the one in the order confirmation email) and the email used for the order.

Endpoint

Older setup: Order Tracking URL

Stores set up before the Order status rule use the module's Order Tracking URL, set as the Order Tracking API URL in the Emporiqa dashboard (Settings → Integration → For your developer). One-click Connect filled it in by itself. That keeps working as before. Where ready-made rules are offered, the module shows it under Advanced as Old order tracking. It always asks for the email on the order. Once Order status is live, the note under Advanced tells you how to switch the old one off: clear the URL in your Emporiqa dashboard first, then switch it off in the module. The old endpoint:

Signed-in customers

When a shopper is signed in to your store, the chat shows them their own prices and uses their account when it hands the conversation to your team. There is nothing to set up: it starts once the module is on the versions below. Guests see your public prices, as before.

• Their own prices, version 1.3.1 or newer: customer-group prices, group discounts, customer-specific prices, quantity discounts and catalog price rules, as PrestaShop calculates them for that customer, with the tax of their own address. The chat asks your store through the signed customer_prices action when it shows a product, and shows the answer to that customer only, on the cards, in quotes and in the product details. Coupons and cart rules apply at your checkout, as before, and a search with a price limit ("under 200") is applied to what the customer pays.
• Their name and email, version 1.3.3 or newer (the Customer info action): the chat greets them by first name, and a handoff reaches your team with the name and email on their account, so they are not asked for them.

Both answer only for the customer the module signed in for this store, and only on that customer's own messages: a shopper who signs out is a guest from their next message. Per customer, prices are kept for 5 minutes and the account details for 30. Each customer is limited to 30 requests and each store to 600 every 10 minutes.

Customer info action

From version 1.3.3 the module answers a signed customer_info request about a shopper who is signed in to your shop: the name and email on their account and their 10 newest orders in the shops you sync (reference, date, status, total and currency). Only that customer's own orders are listed, never a guest order placed with the same email, an address, a phone number or a customer group. With it, a signed-in shopper who asks "where is my order?" without a number gets their newest order, as long as the Order status rule is on; there is nothing to set up.

Requests are signed like Order status and limited to 30 per customer and 600 per shop every 10 minutes. To remove a field or add your own under extra, use the actionEmporiqaCustomerInfo hook, which runs after the answer is built. The upgrade to 1.3.3 registers it.

public function hookActionEmporiqaCustomerInfo(array $params)
{
    $customer = $params['customer'];
    unset($params['data']['customer']['email']);
    $params['data']['extra']['loyalty_points'] = 120;
}

Upgrading

Upgrading to 1.3.3

Upgrade from the Module Manager as usual, then run Sync Products once from the module's Sync tab. It corrects the product links already sent (on PrestaShop 8 they were sent without the category, so the chat did not recognise the product a shopper was looking at); nothing is re-indexed for it.

Upgrading to 1.3.0

1. Check PHP first. 1.3.0 needs PHP 8.0 or newer (8.1 or newer on PrestaShop 9). On PHP 7 the upgrade stops with "Emporiqa 1.3.0 needs PHP 8.0 or newer" and the chat stays off on the storefront until PHP is upgraded.
2. Upgrade the module from the Module Manager as usual. The upgrade clears PrestaShop's Smarty and CCC caches by itself.
3. Purge your full-page cache. If you use a full-page cache module, or a CDN that caches HTML, purge it once after upgrading: cached pages still carry the old chat markup.
4. Run Test Connection. It confirms the connection and warns if your server's clock is more than 2 minutes off.

You don't need to reconnect after upgrading, and order tracking keeps working as before. Click Reconnect only if Emporiqa or the configuration page asks you to.

Troubleshooting