Skip to main content

OASIS v5.3

Release date: August 8th, 2024​

AiFi is thrilled to announce the release of OASIS 5.3, a major update packed with new features, enhancements, and fixes designed to optimize and elevate the retail experience. This release focuses on providing retailers with advanced tools to understand customer behavior, streamline operations, and customize their systems for maximum efficiency and engagement. Here's a high-level overview of the main capabilities and value delivered with OASIS 5.3.

Key Features and Enhancements​

  • Zone API Service
  • Employee to Shopper Product Hand-off
  • Shopper Interaction Count
  • Cloud API Enhancements
  • WebReceipt Customizations
  • Payment and Integrations Improvements
  • System and Observability Improvements
  • Bug Fixes

These updates demonstrate our commitment to delivering cutting-edge solutions that empower retailers to enhance the shopping experience, improve operational efficiency, and drive customer satisfaction. For more information or to enable any of these features, please contact AiFi Support.

OASIS Cloud API​

NEW Zone API Service​

We're introducing a powerful Zone API service that allows retailers to retrieve information about shoppers standing in the specified zone at a given time, together with their metadata and shopping flags. This allows retailers to set up a zone in any part of the store and retrieve customers' metadata upon performing given actions (such as interaction with checkout screen, age verification screen, digital signage, employee applications).

Use Zone API to:

  • Understand how many unique individuals are currently in the zone.
  • Learn if there are multiple people currently in the zone that belong to the same group (or different groups) and build your application logic accordingly.
  • Using timestamps, time travel to see how the given zone looked like in the past (timestamp must be in milliseconds and must not be more than 5 minutes in the past).

Details:

  • Use the below endpoint to query the list of shoppers who are in the zone at the specified time.

    /api/admin/v2/stores/:storeId/zones/:zoneId/shoppers?timestamp={unixMilliseconds}
    curl -X GET {instanceUrl}/api/admin/v2/stores/1/zones/1/shoppers?timestamp=1715603741751

  • The Zone IDs will be provided by the AiFi team.

  • Exemplary responses:

    • No one is in the zone:
{
  "store": {
    "oasisApiStoreId": "1",
    "aifiUniqueStoreId": "trca-us-dtn-3"
  },
  "storeId": "1",
  "storeExternalId": null,
  "shoppers": []
}

  • One shopper is in the zone:

    {
      "store": {
        "oasisApiStoreId": "1",
        "aifiUniqueStoreId": "trca-us-dtn-3"
      },
      "storeId": "1",
      "storeExternalId": null,
      "shoppers": [
        {
          "shopper": {
            "shopperId": "f299dab5-bdb0-4b55-bb55-35f1ff1ed79c"
          },
          "session": {
            "sessionId": "f299dab5-bdb0-4b55-bb55-35f1ff1ed79c",
            "shoppingSessionFlags": []
          },
          "customer": {
            "id": "105388",
            "externalId": null,
            "role": "customer",
            "metadata": null
          },
          "enteredAt": "2024-05-13T12:38:34.022Z"
        }
      ]
    }

  • Multiple shoppers are in the zone:

    {
      "store": {
        "oasisApiStoreId": "1",
        "aifiUniqueStoreId": "trca-us-dtn-3"
      },
      "storeId": "1",
      "storeExternalId": null,
      "shoppers": [
        {
          "shopper": {
            "shopperId": "f299dab5-bdb0-4b55-bb55-35f1ff1ed79c"
          },
          "session": {
            "sessionId": "f299dab5-bdb0-4b55-bb55-35f1ff1ed79c",
            "shoppingSessionFlags": []
          },
          "customer": {
            "id": "105388",
            "externalId": null,
            "role": "customer",
            "metadata": null
          },
          "enteredAt": "2024-05-13T12:38:34.022Z"
        },
        {
          "shopper": {
            "shopperId": "72814be3-53e4-4084-9114-ec27ee06e6f2"
          },
          "session": {
            "sessionId": "72814be3-53e4-4084-9114-ec27ee06e6f2",
            "shoppingSessionFlags": []
          },
          "customer": null,
          "enteredAt": "2024-05-13T12:39:59.373Z"
        }
      ]
    }

  • Please contact the AiFi team to enable this feature for you and set up the Zones.

NEW Employee to Shopper Product Hand-off Experience​

We're introducing a new API feature that allows retailers to assign products to specific shoppers in real time. This empowers retailers to support any scenario where an employee needs to hand a product to the shopper, such as when selling restricted items (alcohol, tobacco) or serving food/drinks (quick serve restaurant/bar).

Exemplary Scenario:

  • Shopper approaches the bar and steps into a zone in front of the bar.

  • The employee opens their application, which pulls data from AiFi about people inside this zone at that time, including images of people and annotations of who is who.

  • The screen displays, and the bartender clicks on the person to whom they will dispense the item, triggering the addition of the event to a specific shopper by sending:

    POST /stores/:storeId/thirdPartyDevices/:thirdPartyDeviceId/events

  • The item lands on the shopper's receipt.

Please contact the AiFi team to enable this feature for you and set up the Zones.

Exemplary Request:

POST /stores/:storeId/thirdPartyDevices/:thirdPartyDeviceId/events
{
  "uuid": "04178fa1-0b07-4e3f-b3ca-6c60d528cf82",
  "timestamp": 1611928852,
  "products": [
    {
      "productReference": "string",
      "quantity": 0,
      "referenceType": "barcode"
    }
  ],
  "shopperId": "f65253aa-c519-4cdd-95da-0689064927ed"
}

NEW Shopper Interaction Count​

We've added a new AI-powered service that allows retailers to retrieve information about shopper interactions.

  • Added information on interaction count to the Checkout Zone PUSH webhook.
  • This allows retailers to set up a zone in any part of the store and get information about shoppers entering it, together with the count and type of interactions registered by the AiFi system up until this point.

Exemplary Response:

"shopper": {
  "shopperId": "123",
  "shopperFlags": ["POTENTIALLY_INTERACTED_WITH_ALCOHOL"],
  "interactionCounts": 10000,
  "restrictedInteractionCounts": 10000
}

Other Cloud API Enhancements​

  • Cart Mutator webhook improvements - added the possibility to return taxLines on the products in Cart Mutator.
  • Added endpoint for changing shopper's sessionId to allow Re-ID from an external service by sending PATCH /admin/v2/stores/:storeId/shoppers/:shopperId with the original sessionId.

WebReceipt​

  • Customize the layout of the receipt page - we've changed the way the layout of web receipts is controlled, making it possible to customize the order and visibility of all elements and adapt the receipts to local needs.

  • Add custom HTML blocks on the receipt page - we've added the possibility to add custom blocks of text at any part of the receipt layout.

  • Use dynamic store details on the receipt page - we've added the possibility to add dynamic information about the store (id, name, address) on the receipt layout in the header, footer, and text blocks, dependent on the store where the purchase was made.

  • Disable credit card expiration date field requirement to retrieve receipts on the WebReceipt portal - in case local/external payment methods don't capture the card expiration date, we've added the possibility to hide this field on the WebReceipt portal so shoppers don't need to input it.

    • The default view:

      Default

    • With expiration disabled:

  • Added Dutch (NL) translations.

  • Changed the English (EN) translations of net/gross on the tax breakdown table.

If you wish to leverage any of the above features, please raise a service request ticket through the AiFi Support portal.

Payments and Integrations​

FreedomPay

  • Improved the refund operation to make it more robust.
  • Improved the authorization adjustment operation to minimize declined adjustments.

Avalara

  • Optimized the Avalara tax calculation calls to avoid unnecessary API requests.

System Improvements​

  • We've onboarded all AiFi services to a new observability platform to allow for faster, more robust, scalable, and centralized monitoring and alerting over store and cloud services.

  • We've implemented several optimizations and improvements in the area of handling shopping events, 3rd party machine events and AI predictions aimed at increasing accuracy of receipts.

  • Implemented additional mechanism to prevent databases to run out of disk space.

  • Added new features to internal store planning tools to streamline the process of setting up privacy curtains and calibrating cameras.

Bug Fixes​

  • Fixed issue with door controller being stuck under high traffic, not able to close/oped gates.

  • Added timeout to service responsible for access validation requests to avoid it being stuck.