Skip to main content

Assistance Request

Assistance Request is a request for help checkout client or any automated requests. Assistance Request can be created by the client or by the system automatically.

To interact with Assistance Requests in Attendant, there is a Rest API available - https://developer.hiiretail.com/api/attendant-api/#tag/AssistanceRequests

Any action on Assistance Request will be published to the SocketIO service.

Note: more about socketio service can be found here

If Assistance Request is not updated for 10 days, it will be removed from the database.

Assistance Request entity depends on:

Types of Assistance Requests​

The assist request type is specified in payload.type of the assist request.

Note: each type may have additional data that is custom to each type. Checkout API spec for more details.

Assistance Request can be of different types, some of them are:

  • AGE_VERIFICATION - created when attendant needs to verify age of the client. Created by the Checkout
  • ASSISTANCE_REQUESTED - general assist request for help from checkout
  • FULL_RESCAN - a fraud detection system requested a full rescan of the basket

Note: more types may be added in the future. so consider API spec is the source of truth.

Entity lifecycle​

  1. Assistance Request is created by the checkout or by the system using updateAssistanceRequest. The new Assist Request is created in 'pending' state. This request should be called from Checkout application, but may also be called by other services automatically (like Basket Evaluation Service).

Note: same endpoint can be used to update assist request with new title or buttons etc.

Event will be published to att.private.notification.assistance-requests.v1 topic

  1. Attendant 'Acts' on assist request by calling actOnAssistanceRequest endpoint, indicating that the request is in progress and attendant is on the way to resolve it. This action should be called from Attendant application.

Event will be published to att.private.notification.assistance-request-processed.v1 topic

  1. Assistance Request is deleted by calling deleteAssistanceRequest endpoint. This action should be called from Checkout application, when attendant did arrived at checkout and accepted the request, and it is no longer needed.

Event will be published to att.private.notification.assistance-request-deleted.v1 topic

Note: if Assistance Request is not updated for 10 days, it will be removed from the database, and no event will be published.