Sales Capture

Overview of Operation

1. Open a websocket to Fieldpine
2. Provide authentication details. This is typically required to be sent through the websocket in addition to any HTTP header requirements
3. Create a session to indicate who is calling.
4. Call fd1.sales.get_activesale_list to recall any sales that are still in progress for this device
5. If no sale already exists, call fd1.sales.create_activesale to create a new sale
6. Add products to the sale
7. Add payment to the sale
8. Trigger receipt printing or emailing

Common Extensions

• Scanning Barcodes
• Eftpos Payments

A minimal wireframe demo, without styling, can be viewed here

Opening A Websocket

To open a websocket, is a simple Javascript operation

    let address = "https://myretail.xyz/fd1/open_websocket";
    let Fd1Socket = new WebSocket(address);

Actual implementations will need to extend this of course.

Authentication

Once the socket is connected, you need to send an authorisation packet. The socket will not process any messages until you have successfully authorised

    let msg = {
        a: "fd1.session.login",
        v: {
            apikey: "...your API key ..."
        }
    }

    if (Fd1Socket.readyState == 1) Fd1Socket.send(JSON.stringify(msg));

Creating a Session