Skip to content
Azimea Docs

PrestaShop

What it brings

Section titled “What it brings”
  • Customers with an account and guest buyers (taken from their orders), as contacts.
  • Orders of the last 12 months and products with price and stock, read through the webservice.
  • Carts as they happen, anonymous ones included, with the email typed at checkout, sent by the module.
  • Newsletter consent with its proof: PrestaShop’s own newsletter box, or the Azimea checkbox if you choose it.

Requirements

Section titled “Requirements”
What Why
PrestaShop 8.0 to 9.x, PHP 8.1+ The versions the module runs on.
The webservice switched on Azimea reads customers, orders and products through it.
The site on HTTPS Keys are never sent unencrypted.
An admin account To create the webservice key and install the module.

How it works

Section titled “How it works”
  • Reading: a webservice key that can only view lets Azimea read customers, orders, order states, currencies, settings, products, categories and stock. It cannot change anything.
  • Sending: the module sends every cart change, the email typed at checkout, orders and their status changes, new and changed accounts, and newsletter consent, the moment they happen. Order states are translated into the common statuses: cancelled, refunded and payment-error states as such, a shipped or delivered state as completed, a paid state as paid, anything else (cash on delivery waiting, for example) as pending.
  • Events are queued in the shop first and leave at the end of the request, after the visitor has the page where the server allows it. Failed deliveries are retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours.

Install and connect

Section titled “Install and connect”

1. Create the webservice key

Section titled “1. Create the webservice key”
  1. In the back office, go to Advanced Parameters › Webservice and switch on Enable PrestaShop’s webservice.
  2. Press Add new webservice key, then Generate, and set the description to Azimea.
  3. Tick View (GET) for customers, orders, order_states, currencies, configurations, products, categories and stock_availables: nothing else.
  4. Save and copy the key (32 letters and digits).

2. Connect in Azimea

Section titled “2. Connect in Azimea”
  1. Open Integrations › PrestaShop › Connect your store.
  2. Paste your shop’s address and the webservice key, then press Check and connect.

3. Install the module

Section titled “3. Install the module”
  1. Download the module: azimea-prestashop.zip.
  2. In the back office, go to Modules › Module Manager › Upload a module and upload the zip.
  3. In Azimea, on the PrestaShop page, under Store plugin, press Generate keys and copy the store key and the secret (shown only once).
  4. Open the module’s Configure page, paste both and press Test connection. The page also shows the last delivery, anything waiting and the consent method chosen in Azimea.
  5. Recommended: call the cron address shown on the module’s page every 5 minutes. Without it, events still leave at the end of each request; only retries wait for later visits.

The key, the secret and the events address can also come from the environment or from constants in config/defines_custom.inc.php (AZIMEA_STORE_KEY, AZIMEA_SECRET); the page then shows them locked.

Statuses

Section titled “Statuses”

The store and plugin statuses are explained in the overview; order statuses in carts and orders.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Fix
stores.prestashop_key_format The key was not copied whole: it is 32 letters and digits. Copy it again.
stores.prestashop_key_rejected PrestaShop refused the key: copied wrong, or its status is off. Check the key and switch its status on.
stores.prestashop_webservice_disabled The webservice is switched off. Advanced Parameters › Webservice › switch it on.
stores.prestashop_webservice_not_found Nothing answered at this address. Check the address and that the webservice is on.
stores.prestashop_permission_missing The key cannot read one of the resources (named in the message). Tick View (GET) for it on the key and try again.
Newsletter sign-ups from the footer block do not arrive Only a signed-in customer’s own address, or one confirmed through the block’s email link, is sent: anyone can type any address in that form. Turn on the newsletter block’s “verification email”.
Plugin status “… deliveries refused” The store key or secret in the module is not the current one. Generate new keys in Azimea and paste them again.

All codes: error codes.

Disconnect

Section titled “Disconnect”

In Azimea, press Disconnect next to the store. In PrestaShop, switch off or delete the Azimea webservice key and uninstall the module; uninstalling removes its tables and settings.

Section titled “Related”