Fluent Commerce Logo
Docs
Sign In

Inventory Batches

Essential knowledge

Authors:

Ankit Mehta, Movyn John, Cille Schliebitz, Anita Gu

Changed on:

3 Feb 2025

Overview

In this lesson, we'll talk about Batches, and the data that can be loaded using Batches.

Key points

  • Intro/Recap on what Batches are
  • Loading Inventory data via Batch

Batch - What is it?

A Batch contains a series of records that will have the same operation applied to it. Batches can be used to load certain types of data (such as inventory) into the Fluent Order Management System.

All batches are run asynchronously, and as such, the client will be required to request a status update for entered batches.

Let us begin by looking at how Inventory data can be loaded via Batch.

No alt provided

Loading Inventory-data via Batch 

Fluent recommends that inventory be loaded to Fluent OMS using the Batch API.

As a first step in the process, the user must create a Job before creating a Batch. 

What you can do with Inventory Batch

With the Inventory Batch, you can:

  • Create a Batch: Create a Batch in the Fluent Order Management
  • View a Batch: Retrieve details of the Batch

Next, let us look at some Inventory Batch properties and what data is available through the APIs.

Below are the fields available for Inventory Batch, which can be updated and retrieved through the APIs.

jobId


  • Type: String
  • Description: { "jobId": "223" }
  • The unique identifier associated with the Job.

action


  • Type: String
  • Description: { "action": "UPSERT" }
  • The type of operation that will be applied to all records in the batch. Possible values are UPSERT.
    • UPSERT: Insert the record. If the record already exists then update the existing record.

entityType


  • Type: Array
  • Description:

{ "retailerId": "197" }
{ "inventoryId": "56470" }
{ "skuRef" : "29SPM0020X96-1-8" }
{ "locationRef" : "158" }
{ "qty": "10" }
{ "correctedQty": "2" }
{ "reservedQty": "2" }

An array of InventoryPost records

  • retailerId(string): The retailer identifier assigned by Fluent Commerce.
  • inventoryId (string): The unique identifier assigned by Fluent Commerce.
  • skuRef (string): The unique reference or code provided by the retailer.
  • locationRef (string): The location (i.e. store) number.
  • qty (integer): The stock on hand.
  • correctedQty (integer): Correction quantity based on stock updates.
  • reservedQty (integer): Quantity reserved due to unfulfilled orders.

status

Type: String

Description:

{ "status": "RUNNING" }

The state of the batch:

  • PENDING - The Batch has been created but is not currently running
  • RUNNING - The Batch is being processed
  • COMPLETE - Batch has been processed ( with or without errors )

Copyright © 2025 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo