VibeFox ShipStation for WooCommerce — Aide

Prérequis

WordPress : 5.8 ou ultérieur.

WooCommerce : 7.0 ou ultérieur, installé et activé. L'extension refuse de s'activer sans lui.

PHP : 8.0 ou ultérieur.

Compte ShipStation : connectez vos transporteurs dans ShipStation (Settings > Shipping > Carriers), puis copiez l'API Key et l'API Secret depuis ShipStation > Settings > Account > API Settings. L'accès à l'API dépend de votre offre ShipStation. Si la page n'est pas disponible, votre offre ne comprend pas l'accès à l'API. L'extension utilise l'API V1 de ShipStation (API Key et API Secret). Les comptes ShipStation API V2 avec une clé API unique ne sont pas pris en charge. Sans clés, seuls les tarifs de secours sont utilisés.

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

Installation

1. Dans WordPress, allez dans Plugins > Add New > Upload Plugin, choisissez le fichier ZIP de l'extension et cliquez sur Install Now. Vous pouvez aussi envoyer le dossier vfd_shipstation dans /wp-content/plugins/ par FTP.

2. Cliquez sur Activate.

3. Ouvrez les réglages : WooCommerce > Settings > Shipping > VibeFox ShipStation, ou cliquez sur Settings sous le nom de l'extension sur la page des extensions.

4. Saisissez votre clé de licence VibeFox dans le bloc de licence en haut de la page et cliquez sur Activate.

5. Collez l'API Key et l'API Secret, saisissez le code postal d'expédition et enregistrez. La page affiche alors les codes transporteur de votre compte. Saisissez le ou les codes souhaités dans Carrier codes et enregistrez à nouveau.

6. Si la devise de votre boutique n'est pas celle de votre compte ShipStation, renseignez Exchange rate.

7. Facultatif : renseignez les tarifs de secours.

8. Ajoutez VibeFox ShipStation à une zone d'expédition dans WooCommerce > Settings > Shipping > Shipping zones, ou activez Ignore shipping zones et choisissez les pays.

Configuration

Tous les réglages se trouvent sur une seule page : WooCommerce > Settings > Shipping > VibeFox ShipStation. Ils s'appliquent à toutes les zones d'expédition. Lorsque vous ajoutez la méthode à une zone, la fenêtre de la zone ne comporte qu'un seul champ :

Title (zone) : le nom que le client voit pour cette zone. Laissez-le vide pour utiliser le Name général.

Chaque fois que vous enregistrez les réglages, les tarifs ShipStation en cache sont effacés et l'API Key et l'API Secret sont vérifiés. La page affiche alors les transporteurs connectés à votre compte avec leurs codes, par exemple "stamps_com (Stamps.com), ups_walleted (UPS by ShipStation)". Les avertissements au-dessus des réglages indiquent quand les tarifs en direct ne peuvent pas fonctionner : clés absentes, code transporteur absent, code postal d'expédition absent, taux de change absent, échec de la vérification de connexion ou codes transporteur non connectés à votre compte.

Général

Enable/Disable : active ou désactive la méthode dans toutes les zones à la fois.

Name : le nom de la méthode d'expédition affiché au paiement. Une zone peut le remplacer par son propre Title. Par défaut : ShipStation Shipping.

Compte ShipStation

API Key : l'API Key de ShipStation > Settings > Account > API Settings.

API Secret : l'API Secret de la même page.

Carrier codes : un ou plusieurs codes transporteur ShipStation, séparés par des virgules, par exemple stamps_com, ups_walleted. Jusqu'à 5 codes sont utilisés, avec une requête API par transporteur. Le tarif le moins cher de ces transporteurs est affiché. Prenez les codes dans la liste affichée après l'enregistrement.

Allowed services : facultatif, codes de service ShipStation séparés par des virgules, par exemple usps_priority_mail, ups_ground. Laissez vide pour afficher le service le moins cher des transporteurs ci-dessus.

Package code : "package" (la valeur par défaut) calcule le tarif de votre propre carton et exclut les enveloppes et les cartons à tarif forfaitaire du transporteur. Laissez vide pour calculer le tarif de tous les types de colis proposés par le transporteur.

Expédition depuis

Ship-from postal code : obligatoire pour les tarifs en direct. ShipStation calcule les tarifs à partir du code postal uniquement, et celui-ci doit se trouver dans le pays de votre compte ShipStation. Laissez vide pour utiliser le code postal de la boutique défini dans WooCommerce > Settings > General.

Tarifs

Parcels : la manière dont le panier est envoyé à ShipStation.

ShipStation account currency : la devise dans laquelle ShipStation renvoie les tarifs : USD, CAD, GBP, AUD, NZD ou EUR. Par défaut : USD (comptes américains).

Exchange rate : le prix de 1 unité de la devise du compte dans la devise de votre boutique, par exemple 0.92. Nécessaire uniquement si la devise de la boutique diffère de celle du compte. Sans ce taux, les tarifs en direct ne sont pas utilisés et les tarifs de secours s'appliquent. Les taux de change ne sont pas mis à jour automatiquement.

Tax status : Taxable permet à WooCommerce d'ajouter une taxe sur l'expédition selon vos règles fiscales ; None ne l'ajoute pas. Les tarifs ShipStation n'incluent pas la taxe de vente.

Tarifs de secours (utilisés en l'absence de tarif en direct : pas de clés API, ShipStation injoignable, aucun tarif transporteur pour l'adresse ; tarifs dans la devise de votre boutique ; laissez le tableau et Other countries vides pour masquer la méthode dans ce cas)

Prices by country : un tableau avec un tarif de base par pays et des colonnes de taille selon le poids du colis : XS ≤1 kg, S ≤2 kg, M ≤3 kg, L ≤5 kg et XL >5 kg. Cliquez sur + Add country pour ajouter une ligne et sur la croix pour en supprimer une. Une taille vide utilise le tarif de base. Un tarif de base de 0 signifie livraison gratuite. La ligne * Default (all other countries) s'applique aux pays qui n'ont pas de ligne propre.

Other countries : le tarif lorsque le tableau ne contient pas de tarif pour le pays. Laissez-le vide pour masquer la méthode dans ce cas.

Conditions

Free shipping from : le sous-total du panier à partir duquel la livraison est gratuite. Aucune requête n'est alors envoyée à ShipStation. Laissez vide pour désactiver cette option.

Minimum subtotal : n'affiche la méthode que si le sous-total du panier atteint au moins ce montant. Laissez vide pour toujours l'afficher.

Minimum weight : le poids minimum du panier, dans l'unité de poids de votre boutique, pour afficher cette méthode. 0 signifie sans limite.

Maximum weight : la méthode est masquée au-delà de ce poids de panier, dans l'unité de poids de votre boutique. 0 signifie sans limite.

Disabled shipping classes : masque la méthode si le panier contient un produit appartenant à l'une de ces classes d'expédition WooCommerce.

Disponibilité sans zones d'expédition

Ignore shipping zones : propose la méthode pour les pays indiqués ci-dessous, qu'elle soit ajoutée ou non à une zone.

Countries : les pays de destination pour ce mode. Laissez vide pour utiliser tous les pays vers lesquels la boutique livre. Ce champ n'est utilisé que lorsque Ignore shipping zones est activé. Une méthode ajoutée à une zone d'expédition fonctionne toujours pour les pays de sa zone.

Avancé

Debug log : enregistre les requêtes ShipStation dans WooCommerce > Status > Logs, source vfd-shipstation. Les erreurs d'API sont toujours enregistrées, même lorsque cette option est désactivée. L'API Key, l'API Secret et les adresses des clients ne sont jamais enregistrés. Le code postal est masqué.

Remove data on uninstall : lorsque l'option est activée, la suppression de l'extension efface ses réglages et ses méthodes dans les zones d'expédition. La désactivation de l'extension ne supprime jamais les réglages.

Fonctionnement au moment du paiement

Lorsque le client saisit une adresse de livraison, WooCommerce demande un tarif à l'extension. L'extension vérifie d'abord les conditions : poids du panier, sous-total minimum et classes d'expédition désactivées. Si la livraison gratuite s'applique, la méthode s'affiche avec un prix de 0 et aucune requête n'est envoyée à ShipStation.

L'extension envoie ensuite à ShipStation le code postal d'expédition, le pays de destination, l'état ou la région, la ville et le code postal, le poids du colis et les dimensions du carton. Aucune requête n'est envoyée tant que le client n'a pas saisi de code postal. Les pays sans code postal reçoivent les tarifs de secours. Les poids et dimensions sont convertis depuis les unités de votre boutique. Les articles sont empilés dans un carton. Si un produit n'a pas de dimensions, le colis n'est calculé qu'au poids.

ShipStation est interrogé une fois par code transporteur. L'extension affiche le tarif autorisé le moins cher, converti dans la devise de votre boutique, sous le nom de la méthode.

Chaque réponse est mise en cache pendant 1 heure. Lorsque ShipStation répond sans tarif utilisable, la réponse est mémorisée pendant 10 minutes. Lorsque ShipStation rejette les clés ou est injoignable, les requêtes sont suspendues pendant 5 minutes. Après une limite de débit, la pause suit l'heure de réinitialisation indiquée par ShipStation. Le délai d'expiration d'une requête est de 12 secondes. La désactivation de l'extension vide le cache des tarifs.

En l'absence de tarif en direct, le prix provient du tableau des tarifs de secours, puis de Other countries. Si aucun des deux ne s'applique, la méthode est masquée. Le client ne voit jamais les messages d'erreur de ShipStation. Les détails sont envoyés au journal WooCommerce.

La méthode fonctionne sur le paiement classique ainsi que sur les blocs Panier et Paiement. Elle est compatible avec WooCommerce High-Performance Order Storage (HPOS).

L'extension ne calcule que des tarifs. Elle n'achète pas d'étiquettes, ne crée pas de commandes ou d'envois dans ShipStation, ne suit pas les colis et ne gère pas les retours. Il n'y a pas de points relais, pas de choix entre plusieurs services au paiement, pas de vérification d'adresse, pas d'assurance, pas de confirmation de signature, pas de répartition en plusieurs colis et pas de majoration des tarifs.

Commandes

La ligne d'expédition de la commande enregistre le Service choisi, par exemple "USPS Ground Advantage - Package". Vous le voyez sur l'écran d'administration de la commande et pouvez créer l'étiquette correspondante dans ShipStation.

Clé de licence

L'extension fonctionne avec une clé de licence VibeFox obtenue sur vibefox.net. Le bloc de licence se trouve en haut de WooCommerce > Settings > Shipping > VibeFox ShipStation. Collez la clé dans License key et cliquez sur Activate. Le bloc affiche le statut, par exemple la date jusqu'à laquelle la licence est active, ainsi que votre domaine. Utilisez Check now pour vérifier à nouveau le statut, Change key pour saisir une autre clé et Remove key pour la retirer de ce site. Le lien Manage licenses and domains in your account ouvre votre compte vibefox.net.

Une clé fonctionne pour un seul domaine. Retirer la clé d'un site ne libère pas son emplacement de domaine. Libérez-le depuis votre compte vibefox.net.

Sans clé active, ShipStation n'est pas affiché aux clients au paiement. Les gestionnaires de la boutique connectés le voient toujours, marqué (unlicensed — visible to admins only), afin que vous puissiez configurer et tester l'extension avant d'acheter une clé. Un rappel apparaît sur la page des extensions et sur les pages WooCommerce. Les commandes existantes ne sont pas affectées.

Lorsqu'une licence expire, l'extension continue de fonctionner, mais les mises à jour et l'assistance nécessitent un renouvellement. Le statut est vérifié automatiquement en arrière-plan.

Dépannage

ShipStation n'apparaît pas au paiement : vérifiez que la licence est active, que Enable/Disable est activé et que la méthode est ajoutée à la zone du pays du client (ou que Ignore shipping zones est activé et que le pays est autorisé). Contrôlez les limites de poids, Minimum subtotal et Disabled shipping classes. Sans tarif en direct, vérifiez que le pays, * Default ou Other countries a un tarif.

Le paiement affiche le tarif de secours au lieu du tarif ShipStation : consultez les avertissements en haut de la page des réglages (clés, code transporteur, code postal d'expédition, taux de change). Activez Debug log et ouvrez WooCommerce > Status > Logs, source vfd-shipstation. Le code postal du client est requis. Aucune requête n'est envoyée tant qu'il n'est pas saisi.

Quel code transporteur saisir : enregistrez les réglages avec la clé et le secret. La page affiche les codes transporteur de votre compte. Utilisez-en un ou plusieurs.

Le tarif diffère de ShipStation : le colis est construit à partir des poids et dimensions des produits, avec les articles empilés dans un carton. Les produits sans dimensions ne sont calculés qu'au poids. Les tarifs sont mis en cache pendant 1 heure. Enregistrez les réglages pour vider le cache.

Pour les développeurs : les filtres vfd_shst_rate_request, vfd_shst_selected_rate et vfd_shst_api_url modifient la requête de tarif par transporteur, le tarif choisi et l'URL de base de l'API.

Le bloc de licence affiche une erreur : suivez le message affiché dans le bloc. Par exemple, si la clé est déjà utilisée sur un autre domaine, libérez un emplacement dans votre compte vibefox.net et cliquez sur Check now. Si l'adresse du site a changé, cliquez sur Check now pour activer la clé pour le nouveau domaine. Si le serveur de licences est injoignable, l'extension continue de fonctionner avec le dernier statut connu.

Désinstallation

La désactivation de l'extension conserve les réglages et efface seulement les tarifs en cache. Pour la supprimer, désactivez-la puis supprimez-la sur la page Plugins. La clé de licence et le statut de licence de cette extension, les tarifs en cache et la liste des transporteurs enregistrée sont toujours supprimés. Les réglages et les méthodes de zone ne sont supprimés que si Remove data on uninstall était activé. Sinon, ils sont conservés pour une réinstallation ultérieure. Les commandes existantes conservent leurs lignes d'expédition.

ShipStation est une marque commerciale de son propriétaire respectif. Cette extension n'est ni affiliée à ShipStation ni approuvée par ShipStation.