Digital Menu Board Order Data API

The Order Object represents an order placed through the POS system. This object contains information such as ordered items, discounts, taxes, and payment details.

The OrderItem Object represents a single item included in the order.

The Qualifier Object represents a qualifier or attribute associated with an OrderItem.

The Discount Object represents a discount applied to an OrderItem or the entire Order.

The Tax Object represents the individual tax applied to the Order.

The PaymentUrl Object represents URL and payment provider information.

The Payment Object represents a single payment made for the Order.

The ErrorResponse Object represents the Error information.

The Error Object represents the error name and message.

The ValidationError Object represents the Error details.

An example of an Order Data request:

const host = '192.168.0.102'; // IP address of the DMB device
const port = 55555; // Port of the OCU end point

const order = {
    balanceDue: 10.0,
    change: 5.0,
    discounts: [
        {
            id: 'discount-10',
            name: '10% Off',
            price: 2.0,
            quantity: 1,
        },
    ],
    items: [
        {
            id: 1,
            name: 'Item 1',
            price: 8.0,
            quantity: 2,
        },
        {
            id: 2,
            name: 'Item 2',
            price: 5.0,
            quantity: 1,
        },
    ],
    orderTime: '2023-06-20T10:30:00Z',
    paymentUrl: {
        url: 'https://example.com/payment',
        provider: 'Stripe',
    },
    payments: [
        {
            amount: 15.0,
            name: 'Credit Card',
        },
    ],
    orderState: 'paid',
    subtotal: 21.0,
    tax: 2.0,
    taxes: [
        {
            name: 'Sales Tax',
            amount: 2.0,
        },
    ],
    total: 18.0,
    totalDiscount: 2.0,
    totalPayments: 15.0,
    totalTips: 0,
};

const socket = new WebSocket('ws://'+ host + ':' + port);

socket.addEventListener('open', (event) => {
    console.log('Connection: ws://' + host + ':' + port);

    //Convert the Order object to string
    const orderJson = JSON.stringify(order);
    //Send the Order data over the socket
    socket.send(orderJson);
});

// Server only message if error occurred
socket.addEventListener('message', (event) => {
    console.error('Error from the server:', JSON.parse(event.data));
});