Aide à l'utilisation de la caisse enregistreuse

Webservices

Enregistrement des ventes réalisées sur un outil externe dans ce logiciel

Les webservices sont disponibles dans ce logiciel afin de pouvoir enregistrer des ventes dans le logiciel de manière automatisée.
Ceci peut être utilisé afin d'enregistrer les ventes effectuées dans votre propre logiciel ou site web.
Afin de pouvoir utiliser les webservices, vous devez avoir souscrit à une licence étendue.
Lorsque les webservices sont activés, un nouvel onglet apparait en page Config, intitulé Webservices.
Dans cette page, vous pouvez construire un exemple de requête pour enregistrer une vente, ainsi que votre clé d'accès à l'interface.
Une commande peut être enregistrée dans le logiciel à l'aide d'un seul appel à une URL particulière, par exemple :

/workers/webapp.php?idboutique=ID_SHOP&key=KEYPARAM&payment=ID_PAYMENTMETHOD&deliveryMethod=ID_DELIVERYMETHOD&idUser=ID_USER&client[nom]=TestClientName&client[prenom]=TestClientSurname&client[email][email protected]&client[pays]=FR&itemsList[]=-ID_DEPT_1_TestDept&itemsList[]=ID_ITEM1_1_TestItem&itemsList[]=ID_ITEM2_2_AnotherTestItem&dateValeur=TIMESTAMP_DATE

Vous pouvez préciser différents paramètres dans la requête (vous pouvez avoir besoin de récupérer les identifiants de votre catalogue via cette page Webservices) :
- ID_SHOP et KEYPARAM sont des paramètres fixés pour votre compte boutique.
- ID_PAYMENTMETHOD est l'identifiant de la méthode de paiement choisie
- ID_DELIVERYMETHOD est l'identifiant de la méthode de livraison choisie
- ID_USER est l'identifiant de l'utilisateur enregistrant la vente
- Ensuite, il est possible de soit préciser l'identifiant d'un client, soit de fournir les informations pour la création d'une nouvelle fiche client
- Puis il faut préciser la liste des articles qui vont être ajoutés dans la commande
- Optionnellement il est possible de spécifier une date (au format timestamp unix)

Une fois vos différents choix effectués à partir de la page Webservices, cette page vous fournira l'url à appeler, ainsi que des exemples de code afin d'effectuer cet appel écrit en Java, Php, Node.js, jQuery ou avec une ligne de commande curl.

Télécharger un export des ventes

Il est possible de télécharger les rapports de ventes d'une journée particulière en utilisant notre API.
Les rapports sont dans les mêmes formats que les rapports disponibles en page Rapport : html, PDF, CSV, XML, XLS...

Télécharger la liste des articles, rayons, clients, etc

Il est possible de télécharger le catalogue d'articles, clients, rayons, etc, en utilisant notre API.
Le format de sorite peut être csv, html, ou json.

Obtenir une notification lors d'une vente

Il est possible de configurer un webhook (en page Configuration, options générales, paragraphe "Options interface") qui sera appelé lorsqu'une nouvelle commande est validée, ou est terminée.
Lorsque vous spécifiez une URL pour le paramètre webhook, alors le logiciel appellera l'URL configurée à chaque vente, avec les paramètres suivants :
- type : le type de notification : cela peut être "validated" ou "terminated". Pour chaque commande le webhook sera appelé deux fois, une première fois lorsque la commande est validée, et que la facture est disponible, une deuxième fois lorsque le paiement de la commande est terminé.
- orderID : le numéro de commande dans votre comptabilité
- orderInternalID : le numéro de commande interne
- price : le prix total de la commande
- clientID : l'identifiant du client
- client : les données du client
- cashBoxID : l'identifiant de la caisse
- deliveryMethod : la méthode de livraison
- PDFinvoice : le lien pour télécharger la facture au format PDF
- items : la liste des articles au format json
- VATs : la liste des taux et montants de TVA
- VAT : le montant total de TVA - isRefund : true/false suivant que la commande est un remboursement ou non Inscrivez-vous maintenant


A partir de l'aide Caisse tactile avec TPE