How to use Inventory Batches

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Topic

Author:

Fluent Commerce

Changed on:

9 Dec 2024

Overview

A topic on how to run Inventory batches in the OMS.

Important Note: Batch Pre-Processing Disabled Accounts Only

The following integration steps and guidelines are specifically applicable to accounts where batch pre-processing has been disabled. If your account has batch pre-processing enabled, please refer to the relevant documentation for alternative instructions.

Author:

Fluent Commerce

Changed on:

9 Dec 2024

Overview

An Inventory Batch is a bulk upload of Inventory Updates. These will typically range from 10,000 updates to in excess of 1 million updates. By using the Batch API you are able to leverage Fluent Big Inventory's ability to scale, enabling increased speed of processing and faster Inventory Availability.

Key points

In what use cases can you use Inventory Batches
Capabilities of the platform this process uses
Supplementary guides

In what use cases can you use Inventory Batches

The primary use cases you should be using Inventory Batches:

Sending periodic updates of stock from the Inventory source of truth; in typical architectures, this will be an ERP that has collected all Inventory Updates during the last cycle (typically daily).
Informing the OMS of the latest stocktake ensures that the OMS is aware of any changes that may have been manually handled, e.g., missing or damaged stock.

Capabilities of the platform this process uses

After using this document, you will be able to run an Inventory Batch. If you need to extend or build on this document's capabilities, the below pages will link to the core capabilities used.

Capability	Description
Job API	API to create & manage batch loading of information

Author:

Fluent Commerce

Changed on:

9 Dec 2024

Key Points

A step-by-step guide on how to send Inventory batches into OMS

Steps

API Authentication

Authenticate against the Retailer you are sending the Inventory Batch to

Please follow the Authentication API page for how to Authenticate against a Retailer.The returned token will be used to authenticate all the following API calls.

Create a new job to run your Batches against

Using the Job API you can create a new Batch Job.

Example URL

`POST/{fluent.account.host}/api/v4.1/job`

1{
2    "name": "Batch Inventory Job",
3    "retailerId": "{retailer id}"
4}

1{
2    "id": "199"
3}

This id number is the Job id which has been created, save this id as we will use it in the following requests for sending a Batch. This Job id and the created Job will be used to group subsequent Batches together.

Create and send a new Inventory Batch

Using the Job API you can create an Inventory Batch to be processed under the previously created Job.The URL is using the Job id of 199 returned by the last API call.

Example URL

`POST/{fluent.account.host}/api/v4.1/job/{jobID}/batch`Example:`POST/{fluent.account.host}/api/v4.1/job/199/batch`

1{
2  "action": "UPSERT",
3  "entityType": "INVENTORY",
4  "entities": [
5    {
6      "retailerId": "{retailer id}",
7      "locationRef": "LOC1",
8      "skuRef": "SKU123",
9      "qty": 100,
10      "correctedQty": 0
11    }
12  ]
13}

1{
2  "id": "331"
3}

The returned id will be used to check the Batch status in a following call. If you needed to send multiple groups of updates you would run this call for each group of Batches that you are running. If you needed to send 15,000 updates you would run this 3 times for each 5,000 records, all under the same Job.

Check Job status

You can use the Job API again to check the status of an existing Job, this will share with you the status of Batches which are part of that Job.

Example URL

`GET/{fluent.account.host}/api/v4.1/job/199`

1{
2  "jobId": "199",
3  "status": "OPEN",
4  "batch": [
5    {
6      "batchId": "331",
7      "status": "COMPLETE",
8      "createdOn": "2022-10-06T00:31:08.104+0000"
9    }
10  ],
11  "createdOn": "2022-10-06T00:31:08.104+0000"
12}

Check Inventory Batch status

You can view the status of a specific Batch as well, this provides a few more details than the previous Job status check.The URL uses the Job id and the Batch id returned by previous APIs.

Example URL

`GET/{fluent.account.host}/api/v4.1/job/199{jobID}batch/{batchID}`Example:`GET/{fluent.account.host}/api/v4.1/job/199/batch/331`

1{
2  "batchId": "331",
3  "entityType": "INVENTORY",
4  "status": "COMPLETE",
5  "start": 1,
6  "count": 10,
7  "total": 0,
8  "results": [],
9  "createdOn": "2022-10-06T00:36:09.344+0000"
10}

Author:

Fluent Commerce

Changed on:

9 Dec 2024

Overview

provides common practices to ensure running a successful Inventory batches

Key points

A number of factors need to be considered in order to create a successful Inventory run:
- Size of Batch files
- Best use of Jobs
- Number of Batch files
- Spread of Batch file counts
- What to do if the number of updates is too small
- Visibility of successful Batch processing

[Warning: empty required content area]

Create and send a new Inventory Batch

Using the Job API you can create an Inventory Batch to be processed under the previously created Job.The URL is using the Job id of 199 returned by the last API call.

Example URL

`POST/{fluent.account.host}/api/v4.1/job/{jobID}/batch`Example:`POST/{fluent.account.host}/api/v4.1/job/199/batch`

1{
2  "action": "UPSERT",
3  "entityType": "INVENTORY",
4  "entities": [
5    {
6      "retailerId": "{retailer id}",
7      "locationRef": "LOC1",
8      "skuRef": "SKU123",
9      "qty": 100,
10      "correctedQty": 0
11    }
12  ]
13}

1{
2  "id": "331"
3}

How to use Inventory Batches

Overview

Inventory Batches - Introduction

Overview

Key points

In what use cases can you use Inventory Batches

Capabilities of the platform this process uses

Send Inventory Batches

Key Points

Steps

API Authentication

Authenticate against the Retailer you are sending the Inventory Batch to

Create a new job to run your Batches against

Create and send a new Inventory Batch

Check Job status

Check Inventory Batch status

Best Practices for Inventory Batches

Overview

Key points

Fluent Commerce

Building Blocks

Browse By Type

Helpful Resources

Quick Links

API Authentication

Authenticate against the Retailer you are sending the Inventory Batch to

Create a new job to run your Batches against

Create and send a new Inventory Batch

Check Job status

Check Inventory Batch status