Get POS status

Call info

Method	GET
Location	{BaseURL}/V1/Stores/{StoreCode}
Body payload
Result	storeDetails

Description

Sometimes things can go wrong. Internet can drop, PC's can crash, people can forget to start the CashDesk client.

While these events can not be handled on forehand (we all lack the ability to foresee the future), you want to minimize the risk of unprocessed or late orders. This is why we have the ability to check the online status of a store.

With the ability to check the healthiness every couple of minutes you can make sure the POS system is alive and processing orders.

Store Times

Besides checking the health status, we also provide you with details about the current minimal process time (for takeout) and minimal delivery times.

In restaurant rush hour, orders will pile up and the kitchen and / or drivers can not keep up with the order flow. The manager can either close some sales channels or tweak some times to manage expectations for the customer.

The POS system provides these by altering 2 parameters, the minimal pickup times and the minimal delivery time. With these parameters, you can adjust the application so customers can not select a delivery / pickup time that cannot be met by the store.

Exceptions

In case of an exception where we cannot recover from, a special object is returned. The body load will always be of the type simpleMessage.

HTTP Code 404
If status code is 404, an resource could not be allocated. For example, the store code was not found. The details will be in the message.

HTTP Code 400
If status code is 400, the body payload sent was incomplete or malformed and could not be parsed by the system. More details (if available) can be found in the message.

HTTP Code 500
If status code is 500, you probably have blown up our server :). This is triggered if something happens unforeseen. If details are available, we will provide these in the message part.