Attendant API

The Attendant API is a service that provides a RESTful API for the Attendant application.

Base URL: https://attendant-api-v2.retailsvc-test.com

Primary use cases are:

• Listen for workstation status changes
• Listen for basket changes
• Handle assistance requests of different types

Backwards compatibility

If you are connecting to existing attendant over GRPC API (legacy POSes usually), please read through the backwards compatibility section. It explains how to connect to new backend with almost 0 changes.

Concepts

Main concepts of the Attendant API are:

• Workstation
• Basket
• Assistance Requests

Integrations

The Attendant API supports integrations with external services:

• Flic Button Integration - Connect Flic buttons to trigger task creation in the Attendant API

Architecture

A simplified architecture diagram of the Attendant API can be found below:

The Attendant API has 2 access points:

• RESTful API - for synchronous communication and mutation of data. More information about the RESTful API can be found here
• SocketIO service - attendant api publishes async events to SocketIO service for edge applications to consume. Read more about the service and what topics that attendant expose here