Fluent Commerce Logo
Docs
Help & Feedback

Content in this track:

Fluent Big Inventory - Features Overview

1

Getting Started with Fluent Big Inventory

2

Inventory Ingestion

3

Inventory Batch

4

How to Submit Inventory Batches

5

Fluent Big Inventory Web App

6

Metrics Overview

7

How Metrics works

8

Metrics usage for Platform Observability

9

Inventory Feeds

10

How do Inventory Feeds work

11

End Of Track

12

How do Inventory Feeds work

Essential knowledge

Author:

Fluent Commerce

Changed on:

22 Aug 2024

Overview

This document will describe how Inventory Feeds work and guide users through understanding any prerequisites to integrate with Inventory Feeds.

Key points

  • Inventory Feeds will export a view of inventory data from the Fluent platform into a Customer environment
  • The schedule of the export is configurable based on the Customer requirements
  • The exported data is ready to be synced with any further systems within a Customer ecosystem to provide real time inventory availability

Pre-Requisites

This document assumes you are knowledgeable and aware of the following subjects:

Inventory Feed Components

Inventory Feeds is an inventory availability data export tool. They allow users to create a programmatic export of selected inventory data, ready to be consumed by any inventory-aware system.Inventory Feeds contain two technical components:
  • Inventory Feed
  • Inventory Feed Run

Inventory Feed

The Inventory Feed component is the “parent” data modal of the Inventory Feed. This is where an Inventory Feed is configured and set up. At the Inventory Feed level, you can define information such as:
  • Export Schedule
  • Target destination
  • Data filters

Inventory Feed Run

Under an Inventory Feed, there is a one-to-many relationship to Inventory Feed Runs. Each Run is an individual execution that exports a new data file based on the configuration of the parent Inventory Feed.Each Inventory Feed Run contains information such as:
  • Status of the run (success / failed)
  • Total amount of exported inventory items
  • Type of run (incremental or full)
Inventory Feed Runs are created by the Fluent Big Inventory system based on the settings configured at the Inventory Feed parent level.

Inventory Feed Data Flow

Inventory Feeds are designed to export tailored views of inventory availability into your own ecosystem. Once the data has been exported to your ecosystem, it will be in an easy-to-use format and ready to be shared with any other systems that benefit from inventory availability.

High-Level Diagram

No alt provided

Data Flow

Inventory Feeds are designed to provide data in a format that can be “owned” by the user. Fluent Big Inventory is designed for configurability and extensibility, and this solution enables our customers and partners to best integrate the data from Fluent into a target storage location that can then be integrated into any target system.

How it works

The Inventory Feeds service will trigger a run based on the parent configuration, or 5 minutes by default. When a run executes, it will generate an output of the inventory availability from Global Inventory. This generated view of inventory will be saved into an S3 bucket within the Fluent technology stack.When configuring an inventory feed, a customer- or Partner-owned AWS S3 bucket is required as a target destination. Once the target destination bucket is defined, the Inventory Feed service will set up an AWS cross-account replication service. This service will inspect the S3 bucket within the Fluent tech stack. Whenever it identifies any changes or new files added to the Fluent S3 bucket, the cross-account replication service will immediately start to replicate the changes across to the target destination bucket.At this point, the target S3 bucket will have an exact copy of the inventory availability data generated by the Inventory Feed. This data can then be used to provide a view of inventory availability. Additionally, this also provides a historic cache of inventory availability snapshots all the way back to the first initial run of the Inventory Feed.

Types of Inventory Feed Runs

Inventory Feed Runs come in two types: FULL and INCREMENTAL. Each Inventory Feed automatically determines the type of run based on its configuration and schedule. Users do not set the run type; the system manages it.

Full Feed Run

A Full Feed Run exports all data within the Inventory Feed's configured filters. This type of run establishes a comprehensive starting point for any integration or use of inventory availability data. A Full Feed Run is always triggered the first time an Inventory Feed is activated, ensuring the system starts with a complete set of data. This initial run sets a known foundation, enabling subsequent Incremental Feed Runs to function correctly.

Incremental Feed Run

An Incremental Feed Run exports only the data that has changed since the last Inventory Feed Run. The configured filters and the frequency of the Inventory Feed determine the scope of this data. For instance, if an Inventory Feed is set to run every minute, the incremental changes will be relatively small compared to an Inventory Feed that runs once every hour. Incremental Feed Runs keep inventory data up-to-date with minimal data transfer, focusing only on the changes since the previous run.

How Inventory Feed Runs Work

When an Inventory Feed is created and activated for the first time, it performs a Full Feed Run. This run extracts and exports all inventory data based on the configured inventory data type and filters, providing a complete dataset. Subsequent Inventory Feed Runs, triggered according to the configured frequency, will be Incremental Feed Runs. These runs will only export the data that has changed since the last run, again limited to the configured inventory data type and filters.

File Format

The inventory availability data exported as part of an Inventory Feed will be in a Parquet file format. We have chosen to export in this format because it provides a range of benefits. Some of these benefits are:
  • Open-source - All customers will be able to use and integrate these file types into their existing architectures
  • Schema evolution - Parquet files are designed to evolve. Being column-oriented storage (instead of row-based) and self-describing, Parquet files are designed to evolve, which we expect to happen as we increase the feature set of Inventory Feeds
  • Performance - Parquet files are designed for querying directly and, as a result, perform faster than other types of data files such as CSV or JSON
Parquet File Structure
FieldDescriptionType
idUnique ID for the Virtual or Inventory PositionUUID
statuscurrent status of the Virtual or Inventory PositionString
quantityquantity value saved for the Virtual Position (only saved in exports of type Virtual_Position)Integer
onhand_quantityquantity value saved for the Inventory Position (only saved in exports of type Inventory_Position)Integer
group_referenceLocation or Network reference for the Virtual Position (only saved in exports of type Virtual_Position)String
location_referenceLocation reference for the Inventory Position (only saved in exports of type Inventory_Position)String
virtual_position_typeType of Virtual Position (only saved in exports of type Virtual_Position)String
inventory_position_typeType of Inventory Position (only saved in exports of type Inventory_Position)String
created_onTime the Virtual or Inventory Position was createdDateTime
updated_onLast time the Virtual or Inventory Position was updatedDateTime
product_referenceReference for the Product associated with the Virtual of Inventory PositionString
catalogue_idUnique id for the catalogue of the Virtual or Inventory PositionUUID
external_referenceRef of the Virtual or Inventory PositionString

Inventory Feed Data Model

No alt provided

Related content

Inventory Feeds
Edited 142 days ago
This document is intended to introduce the Inventory Feeds feature to Customers and Partners. This page will describe the Inventory Feeds feature and how they fit within the Fluent Big Inventory Product and will direct the reader to resources describing how to use Inventory Feeds.
Fluent Commerce

Fluent Commerce

Knowledge Tracks Related To This Topic

All about Big Inventory
  • Fluent Big Inventory - Features Overview
  • Getting Started with Fluent Big Inventory
  • Inventory Ingestion
  • Inventory Batch
  • How to Submit Inventory Batches
  • Fluent Big Inventory Web App
  • Metrics Overview
  • How Metrics works
  • Metrics usage for Platform Observability
  • Inventory Feeds
  • How do Inventory Feeds work
    • Building Blocks
    Building Blocks
    Packages & Modules
    All UI Components
    Workflows
    Settings
    Interface Contracts
    All Rules
    By Type
    All Types
    Knowledge Tracks
    Extend Knowledge
    Glossary
    All How-to Guides
    Sitemap
    Topics
    Use Cases
    Helpful Resources
    Platform Limits
    Support Policy
    Service Level Agreement (SLA) - Enterprise
    Deprecation Policy
    Extend Knowledge Content – Terms and Conditions
    System and Organization Controls (SOC) 3 Report
    Data Privacy Addendum
    Security Policy
    Quick Links
    For Partners
    Customer Resources
    Webinars and Events
    Certifications
    Training Resources
    Knowledge Tracks
    Builders Portal
    Product Update Newsletter
    Industry Blogs & Events Newsletter
    Trust Center Portal

    Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

    Fluent Logo