Inventory Batch API
Essential knowledgeCore knowledge to understand Fluent Commerce
Intended Audience:
Technical User
Author:
Fluent Commerce
Changed on:
24 Mar 2025
Overview
The Inventory Batch is designed to send large volumes of inventory data, primarily to update the Last On Hand inventory quantities for inventory positions. While its primary purpose is to handle large-scale inventory updates and ensure the OMS reflects the latest inventory levels after a few days of operations, it is flexible enough to support other inventory types as needed, providing adaptability for diverse inventory management scenarios.Key points
- Create new Inventory Batches using the Job API
- Sample Inventory batch payload
- Inventory batch details
Inventory Batch Submission
In order to create/update inventory data, one can submit an inventory batch using the`/job/{jobId}/batch` endpoint (see link). Multiple Inventory can be updated in a single batch by providing multiple `entities`.Inventory Batch Model
The following describes the fields which can be submitted as part of an inventory batch record.Example Request Payload :
Example Response
Examples of Incorrect Entries
1. Null Entry
An entry that is
`null` does not conform to the model structure and will be ignored. 2. String Instead of Object A string value in the array is not a valid entity object and is thus ignored. 3. Number Instead of Object
Similarly, a numeric entry does not meet the required structure and is ignored.