User account types

info

The Users API and its underlying services are currently being updated to accommodate a better solution for account types. Some properties have been made available under a legacy prefix and any such properties might be deprecated in the near future.

There are several kinds of user accounts in the Future Ordering platform. Ordering guests, administrators using Navigator, developers using the API, and even devices, such as kiosks and order status boards, all act as users within our systems.

When integrating with Future Ordering, it is important to know the difference between these account types.

Identifying account types

It is possible to differentiate between account types using the legacyAccountType property in user information responses.

{
    ...
    "legacyAccountType": "guest",
    ...
}

The following table describes the most common account types:

Account Type	Description
user	A registered guest account.
guest	A temporary guest account.
guest_kiosk	An account used by a kiosk for order placement.
default or navigator_local	A Navigator and/or FO.CLI account.
device_wosb	A device account used by an Order Status Board.
device_kiosk	A device account used by a kiosk.
device_foop	A device account used by the On-Premise service.

warning

Accounts of type user may be in a state where they have been created but not completed, e.g. if the user is yet to complete an email or phone number verification during registration.

The localLogin property will be null or undefined for such accounts.