Fluent Commerce Docs

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Content in this track:

Introduction to Integrations and Connections

Introduction to the Events API

End Of Track

Content in this track: 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.

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.

Note

While, a batch can include a maximum of 5000 records, there is no limit to the number of batches that can be included in a job. Also, a job remains open only for 24 hours.

Recommended Practice

It is recommended to use the same job for all the batches created throughout the day, create a new job only when the last job is closed.

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: