VibeFox Frenet for PrestaShop — Aide

Prérequis

PrestaShop : 8.0 à 9.x.

PHP : 8.0 ou ultérieur. Le module refuse de s'installer sur des versions antérieures de PHP.

Compte Frenet (uniquement pour les cotations en temps réel) : créez un compte gratuit dans le panneau Frenet (painel.frenet.com.br), activez les transporteurs que vous utilisez et copiez votre jeton d'API. Si vous n'utilisez que des tarifs fixes, vous n'avez pas besoin de compte Frenet.

Produits : renseignez le poids et les dimensions pour des tarifs précis. Les produits sans ces informations sont cotés sur la base de 0,3 kg et 16 × 11 × 2 cm (la plus petite boîte Correios).

Clé de licence VibeFox : achetée sur vibefox.net. Une clé fonctionne pour un seul domaine.

Installation

1. Dans le back-office, allez dans Modules > Module Manager et cliquez sur Upload a module. Choisissez le fichier ZIP du module.

2. Une fois le téléversement terminé, cliquez sur Configure, ou retrouvez plus tard VibeFox Frenet dans la liste des modules et cliquez sur Configure.

3. Saisissez votre clé de licence VibeFox dans License key, dans le bloc de licence en haut de la page Configure, puis cliquez sur Activate (voir Clé de licence).

4. Collez le jeton d'API et saisissez le CEP d'origine. Si la devise par défaut de votre boutique n'est pas le BRL, saisissez le taux de change du BRL. Vous pouvez aussi ajouter des tarifs fixes et un coût de secours. Cliquez sur Save.

À l'installation, le module crée le transporteur Frenet avec le texte de délai de livraison Delivery by the carriers of your Frenet account. Le transporteur est affecté à toutes les zones et à tous les groupes de clients. Vous pouvez modifier les zones, les groupes de clients, le délai de livraison, le logo et les limites de taille dans Shipping > Carriers. N'y définissez pas de prix : le prix provient toujours du module.

Configuration

Tous les réglages se trouvent sur la page du module : Modules > Module Manager > VibeFox Frenet > Configure. Ils s'appliquent à toutes les zones du transporteur. Chaque section a son propre bouton Save, qui enregistre la page entière. Chaque enregistrement efface aussi les cotations Frenet mises en cache. Les champs de prix acceptent aussi bien le point que la virgule comme séparateur décimal ; une valeur qui n'est pas un nombre est refusée avec le message "…" must be a number. Les montants et poids négatifs, un BRL exchange rate égal ou inférieur à 0, ainsi qu'un Minimum weight supérieur au Maximum weight sont également refusés. En cas d'erreur, rien n'est enregistré.

En haut de la page, le module affiche des avertissements : pas de jeton d'API (seuls les tarifs fixes sont utilisés, ou le transporteur n'est jamais affiché s'il n'y a pas non plus de tarifs fixes), pas de CEP d'origine à 8 chiffres, ou une devise par défaut autre que le BRL sans taux de change. Il avertit aussi lorsque l'unité de poids ou de dimensions de votre boutique n'est pas reconnue par le module ; une telle unité est traitée comme kg ou cm. Définissez une unité standard (kg, g, lb ou oz ; cm, mm, m ou in) dans International > Localization (Local units).

Général

Enable Frenet : active ou désactive le transporteur. C'est le même interrupteur que le statut du transporteur dans Shipping > Carriers.

Method title : le nom du transporteur affiché dans le panier et au moment du paiement. Par défaut : Frenet. Obligatoire, 64 caractères maximum.

Cotations Frenet en temps réel

Frenet compare les transporteurs activés dans votre compte Frenet et renvoie leurs tarifs pour le panier. Les cotations en temps réel ne sont demandées que pour les adresses au Brésil avec un CEP complet à 8 chiffres. La section contient un lien vers le panneau Frenet.

API token : votre jeton d'API Frenet, tiré du panneau Frenet. Laissez-le vide pour n'utiliser que des tarifs fixes. Après l'enregistrement, le champ reste vide et affiche A token is saved — leave empty to keep it. Saisissez une nouvelle valeur uniquement pour la modifier. Pour supprimer le jeton enregistré, cochez Remove the saved token et enregistrez.

Origin CEP : le code postal (CEP) d'où partent les colis, par exemple 00000-000. Laissez-le vide pour utiliser le code postal de la boutique défini dans Shop Parameters > Contact > Stores, si l'adresse de la boutique est au Brésil. Un CEP de moins de 8 chiffres est enregistré tel que saisi, et la page affiche Frenet: the origin CEP must have 8 digits.

Service to offer : Cheapest service (par défaut) ou Fastest service. Frenet renvoie plusieurs services, et le transporteur affiche un seul prix.

BRL exchange rate : Frenet calcule en réaux brésiliens. Si la devise par défaut de votre boutique n'est pas le BRL, indiquez combien vaut 1 BRL dans votre devise par défaut, par exemple 0.16. La cotation et le montant déclaré de la commande sont convertis avec ce taux. Sans lui, les cotations en temps réel ne sont pas utilisées. Lorsque la devise par défaut est le BRL, le champ affiche Not needed (shop currency is BRL).

Tarifs fixes

Utilisés lorsqu'il n'y a pas de jeton d'API, pour les pays que Frenet ne dessert pas, et chaque fois que Frenet ne renvoie pas de prix (API indisponible, CEP non desservi).

Price per country : un tableau avec les colonnes Country, Price, XS, S, M, L et XL, les prix étant exprimés dans votre devise par défaut, hors taxes. Cliquez sur Add country pour ajouter une ligne et sur l'icône de corbeille pour en supprimer une. Les colonnes de taille dépendent du poids du panier : XS jusqu'à 1 kg, S jusqu'à 2 kg, M jusqu'à 3 kg, L jusqu'à 5 kg, XL au-delà de 5 kg. Price est utilisé lorsque la colonne de taille est vide. Un Price de 0 signifie livraison gratuite pour ce pays. Utilisez * Default pour tous les autres pays. Les lignes sans aucun prix sont supprimées à l'enregistrement.

Fallback cost : utilisé lorsque ni Frenet ni le tableau ne fournissent de prix. Laissez-le vide pour masquer le transporteur.

Fixed price applies : Per order facture le prix une seule fois. Per item (price × quantity) le multiplie par le nombre d'articles. Cela ne concerne que les tarifs fixes et le coût de secours. Les cotations Frenet couvrent déjà tout le panier.

Conditions

Minimum weight : masque le transporteur lorsque le poids du panier est inférieur à cette valeur, en kg. 0 signifie aucune limite.

Maximum weight : masque le transporteur lorsque le poids du panier dépasse cette valeur, en kg. Par défaut : 30 (valeur aussi utilisée lorsque le champ est vide). 0 signifie aucune limite. Elle ne peut pas être inférieure au Minimum weight.

Minimum order amount : n'affiche le transporteur que lorsque le sous-total du panier (après remises, avant taxes) atteint au moins ce montant. Laissez-le vide pour l'afficher en permanence.

Free shipping from : le sous-total du panier (après remises, avant taxes) à partir duquel la livraison est gratuite. Laissez-le vide pour ne jamais offrir la livraison gratuite.

Tax : la règle de taxe du transporteur, ou No tax. Les tarifs Frenet sont des prix finaux du transporteur. Choisissez No tax si PrestaShop ne doit pas y ajouter de taxe.

Les poids et dimensions des produits sont convertis des unités de votre boutique en kg et cm.

Disponibilité sans zones de livraison

En règle générale, le transporteur est proposé dans les zones qui lui sont affectées dans Shipping > Carriers.

Ignore shipping zones : propose Frenet pour les pays ci-dessous, quelle que soit la zone correspondante. À l'enregistrement, le transporteur est ajouté à toutes les zones, ainsi qu'aux zones que vous créerez plus tard. Lorsque vous désactivez à nouveau cette option, le transporteur retrouve les zones qu'il avait auparavant.

Countries : les pays de destination pour ce mode, choisis parmi les pays actifs de votre boutique. Laissez-le vide pour utiliser tous les pays vers lesquels vous livrez. Utilisé uniquement lorsque Ignore shipping zones est activé.

Avancé

Debug log : enregistre chaque demande et réponse de cotation dans logs/vfd_frn_debug.log.php, dans le dossier du module. Le fichier ne peut pas être ouvert depuis le web. Les erreurs de l'API sont toujours enregistrées. Le jeton n'est jamais enregistré et le CEP du client est raccourci. Désactivez-le une fois vos vérifications terminées.

Log : affiche la taille et les dernières entrées du journal. Cliquez sur Clear log pour le vider.

Remove data on uninstall : lorsque l'option est activée, la désinstallation du module supprime tous les réglages Frenet, le transporteur et le journal. Lorsqu'elle est désactivée, tout est conservé pour une réinstallation. Les cotations en cache sont toujours supprimées. Les services Frenet enregistrés avec les commandes font partie de l'historique des commandes et sont conservés.

Fonctionnement au moment du paiement

À l'étape de livraison, PrestaShop demande au module le prix Frenet. Seuls les produits physiques comptent : les produits virtuels n'ajoutent aucun poids et ne sont pas inclus dans le montant de la commande. Avant que le client ne saisisse une adresse, le module utilise le pays que la boutique estime pour le visiteur. Le module vérifie d'abord la liste des pays (lorsque Ignore shipping zones est activé), le poids du panier et le montant minimum de commande. Si la livraison gratuite s'applique, le prix est de 0 et aucune requête n'est envoyée à Frenet.

Pour une adresse au Brésil avec un CEP complet à 8 chiffres, le module envoie à Frenet les CEP d'origine et de destination, chaque article du panier (poids en kg, dimensions en cm, quantité, référence produit et catégories), le montant de la commande en BRL et le premier code promo du panier. Aucune requête n'est faite tant que le CEP est incomplet. Frenet renvoie les services de vos transporteurs activés. Les services en erreur ou sans prix sont ignorés. Le module retient le service le moins cher ou le plus rapide et convertit le prix dans votre devise par défaut. Le prix est ensuite affiché dans la devise du panier du client.

Chaque réponse est mise en cache pendant 1 heure pour le même panier et la même adresse. Une requête échouée, ou un CEP qu'aucun transporteur activé ne dessert, est retenu pendant 10 minutes. Le délai d'attente de l'API est de 10 secondes. Dans ces cas, le client ne voit aucune erreur : le tarif fixe ou le coût de secours est utilisé, ou le transporteur est masqué s'il n'y en a aucun. La raison est écrite dans le journal. Pour les adresses hors du Brésil, seuls les tarifs fixes sont utilisés.

Si vous modifiez le transporteur dans Shipping > Carriers alors qu'il a déjà des commandes, PrestaShop l'enregistre comme une nouvelle version du transporteur. Le module suit automatiquement la nouvelle version.

Le module ne calcule que des tarifs. Il ne crée pas d'envois, n'imprime pas d'étiquettes et ne suit pas les colis. Il affiche un seul service Frenet par panier, et non plusieurs, et ne propose ni points de retrait ni consignes. Frenet ne fournit de cotations qu'à l'intérieur du Brésil ; utilisez les tarifs fixes pour les autres pays.

Commandes

Lorsqu'une commande est passée avec le transporteur Frenet, le module enregistre la façon dont son prix de livraison a été calculé. La page de commande du back-office affiche alors un bloc Frenet avec ces lignes :

Carrier : le transporteur Frenet et le service, par exemple un service Correios ou Jadlog. Affiché pour les cotations en temps réel.

Delivery time : le délai de livraison en jours ouvrés renvoyé par Frenet. Affiché pour les cotations en temps réel.

Price source : Live Frenet quote, Fixed price (price per country), Fallback cost ou Free shipping.

Ces données sont conservées lors de la désinstallation du module, y compris avec Remove data on uninstall.

Clé de licence

Le module fonctionne avec une clé de licence VibeFox obtenue sur vibefox.net. Le bloc de licence License — VibeFox Frenet est le premier bloc de Modules > Module Manager > VibeFox Frenet > Configure, au-dessus des réglages. Saisissez la clé dans License key et cliquez sur Activate. Ensuite, le bloc affiche la clé masquée, le statut (par exemple la date jusqu'à laquelle la licence est active et votre domaine) ainsi que les boutons Check now pour vérifier à nouveau le statut, Change key pour saisir une autre clé et Remove key pour retirer la clé de cette boutique. En dessous figurent la ligne Product: presta-shipping-frenet et le lien Manage licenses and domains in your account, qui ouvre votre compte vibefox.net. Seuls les employés disposant de l'autorisation Configure pour le module peuvent modifier la clé. Les textes du bloc suivent la langue du back-office (l'anglais et le russe sont inclus).

Si la clé n'est pas acceptée, le bloc indique la raison, par exemple Key not found, This key belongs to another product, Domain limit reached ou License expired on suivi d'une date. Après un changement d'adresse de la boutique, ou après avoir libéré un emplacement de domaine dans votre compte, cliquez sur Check now. Si le serveur de licences est injoignable, le module continue de fonctionner avec le dernier statut connu.

Une clé fonctionne pour un seul domaine : le domaine de la boutique principale, y compris dans une configuration multiboutique. Retirer la clé de la boutique ne libère pas son emplacement de domaine. Libérez l'emplacement dans votre compte vibefox.net.

Sans clé active, le transporteur Frenet n'est pas affiché aux clients au moment du paiement et aucun tarif n'est calculé. La boutique PrestaShop ne sait pas que vous êtes connecté au back-office, donc le transporteur est masqué pour vous aussi : vous pouvez configurer le module avant d'acheter une clé, mais pas le tester au moment du paiement. Un rappel apparaît dans Modules > Module Manager, dans l'onglet Alerts. Les commandes existantes ne sont pas affectées.

Lorsqu'une licence expire, le module continue de fonctionner, mais les mises à jour et le support nécessitent un renouvellement. Le statut est vérifié à nouveau automatiquement pendant votre travail dans le back-office : une fois par jour pendant les 14 premiers jours après la saisie de la clé, puis une fois par semaine. Aucune tâche cron n'est nécessaire. La désinstallation ou la réinitialisation du module supprime toujours la clé de licence et le statut de la licence.

Dépannage

Frenet n'apparaît pas au moment du paiement : vérifiez que la licence est active et que Enable Frenet est activé. Dans Shipping > Carriers, vérifiez que le transporteur couvre la zone du pays du client et le groupe du client, ou que Ignore shipping zones est activé et que le pays est autorisé. Consultez les avertissements en haut de la page du module, les limites de poids et le Minimum order amount. Causes fréquentes : le client n'a pas encore saisi un CEP complet à 8 chiffres et il n'existe pas de tarifs fixes, ou Frenet n'a renvoyé aucun service pour le trajet et il n'y a pas de tarif fixe. Les produits peuvent aussi être limités à certains transporteurs sur la page produit.

Les cotations en temps réel n'apparaissent pas : activez Debug log, rechargez le paiement et consultez le champ Log sur la page du module. Il indique la raison : pas de CEP d'origine, pas de taux de change BRL, CEP du client incomplet, limite de poids ou de montant, ou messages des services ignorés.

Le journal indique que le jeton d'API a été rejeté (HTTP 401 ou 403) : copiez à nouveau le jeton depuis le panneau Frenet et collez-le dans API token.

Le journal indique que Frenet n'a renvoyé aucun service : activez au moins un transporteur dans le panneau Frenet.

Ma boutique vend en euros ou en dollars : Frenet répond en BRL. Saisissez le BRL exchange rate (combien vaut 1 BRL dans votre devise par défaut).

Une taxe s'ajoute au prix Frenet : les tarifs Frenet sont des prix finaux du transporteur. Réglez Tax sur No tax.

Les tarifs semblent obsolètes après une modification : cliquez sur Save sur la page du module. Cela efface les cotations Frenet mises en cache.

La page indique que le transporteur Frenet est introuvable : le transporteur a été supprimé dans Shipping > Carriers. Réinitialisez le module dans Modules > Module Manager pour le recréer. D'ici là, l'enregistrement affiche The settings were saved, but the carrier could not be updated.

Désinstallation

Allez dans Modules > Module Manager, ouvrez le menu à côté de VibeFox Frenet et choisissez Uninstall. La clé de licence et le statut de la licence sont toujours supprimés. Les cotations en cache sont toujours supprimées. Si Remove data on uninstall est activé, le transporteur est supprimé (les commandes conservent leur historique), et les réglages et le journal sont effacés. S'il est désactivé, le transporteur est seulement désactivé et tous les réglages sont conservés. Réinstaller le module, ou effectuer un Reset, rend au transporteur enregistré le statut qu'il avait auparavant : un transporteur que vous aviez désactivé reste désactivé. Les commandes existantes conservent le transporteur Frenet et le bloc Frenet sur la page de commande.

Frenet est une marque de son propriétaire. Ce module n'est pas affilié à Frenet et n'est pas approuvé par Frenet.