Hilfe für die Nutzung der Kassen

Webservices

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

Webservices are available in this software in order to programatically record sales in the software.
This can be used to record sales made with your own website or software.
In order to use the webservices, you need to purchase an extended licence.
When you enable webservices, a new page becomes visible in the config menu : webservices.
In this page, you can build an example of a query to record a sale, and get you api key.
One order can be recorded in the software with a single call to a particular URL, for example :

/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]=contact@testclient.fr&client[pays]=FR&items[-ID_DEPT]=1_TestDept&items[ID_ITEM1]=1_TestItem&items[ID_ITEM2]=2_AnotherTestItem&dateValeur=TIMESTAMP_DATE

You can provide different parameters in the request (you might need to fetch these parameters values in the webservice config page) :
- ID_SHOP and KEYPARAM are fixed parameters for your shop account.
- ID_PAYMENTMETHOD is the ID of the payment method you selected
- ID_DELIVERYMETHOD is the ID of the delivery method you selected
- ID_USER is the ID of the user processing the sale
- You can either put the ID of an existing client, either provide client information
- Then you need to provide the list of items that will be added to the order
- Optionnally you can provide a date (in the unix timestamp format)

Finally in the webservice config page, you will get code example in order to request the webservice written in Java, Php, Node.js, jQuery or curl commandline.

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 Register now


A partir de l'aide Caisse tactile avec TPE