Point of sale terminal (POS), Web services

Help for the use of cash register


Recording of sales made on an external tool in this software

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 :

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.

Download a sales export

It is possible to download sales reports of a particular day using our API.
The reports are in the same formats as the reports available on the Report page: html, PDF, CSV, XML, XLS...

Download list of items, departments, clients, etc

It is possible to download the catalog of articles, customers, departments, etc., using our API.
The output format can be csv, html, or json.

Get notified during a sale

It is possible to configure a webhook (on the Configuration page, general options, "Interface options" paragraph) which will be called when a new order is validated, or is completed.
When you specify a URL for the webhook parameter, then the software will call the configured URL on each sale, with the following parameters:
- type: the type of notification: this can be "validated" or "terminated". For each order the webhook will be called twice, a first time when the order is validated, and the invoice is available, a second time when payment for the order is completed.
- orderID: the order number in your accounting
- orderInternalID: the internal order number
- price: the total price of the order
- clientID: the client identifier
- customer: customer data
- cashBoxID: the cash box identifier
- deliveryMethod: the delivery method
- PDFinvoice: the link to download the invoice in PDF format
- items: the list of articles in json format
- VATs: the list of VAT rates and amounts
- VAT: the total amount of VAT - isRefund: true/false depending on whether the order is a refund or not

From help Cashier app mobile