Fluent Commerce Logo
Docs
Help & Feedback
Sign In

How to use Direct Inventory Updates

Topic

Author:

Fluent Commerce

Changed on:

23 Sept 2024

Overview

Direct Inventory Updates are one of the two reference ways to send last-on-hand inventory updates into your inventory workflows. Direct Inventory Updates are best used when you have a small volume of inventory updates (maximum of 1000 updates).

Introduction

Author:

Fluent Commerce

Changed on:

23 Sept 2024

Overview

Direct Inventory Updates are one of the two reference ways to send last-on-hand inventory updates into your inventory workflows. Direct Inventory Updates are best used when you have a small volume of inventory updates (maximum of 1000 updates).

As part of the Inventory Module, we have provided a reference implementation. This includes the workflow JSON, rules, & configurations required to implement direct inventory updates.

Key points

  • Direct updates are designed to be used when the number of Inventory updates is quite small, less than 1000 updates
  • Capabilities of the platform this process uses
  • Supplementary guides

When should you use direct updates?

Direct updates are designed for use when the number of Inventory updates is quite small, less than 1000. Using direct updates results in quicker processing of inventory vs. batch uploads when operating at these lower inventory volumes.

Direct updates are best used in conjunction with batch inventory updates. When a specific job has 1000 or fewer updates, direct updates should be used; if the job has more than 1000 updates, the batch should be used.

Capabilities of the platform this process uses

Capability

Description

Event API

API to send the events against

Supplementary guides

Guide

Description

How to send Delta Inventory updates

Learn how to send delta inventory updates via events

How to use Inventory Batches

Learn how to use Inventory Batches and follow the suggested best practices

Send Direct updates

Author:

Fluent Commerce

Changed on:

23 Sept 2024

Key Points

  • Perform smaller inventory updates by sending an event into your workflow via event API.

Steps

Step arrow right iconStep 1: Authenticate against the Retailer you are sending the direct updates

For use of authentication please read: Authentication

The returned token will be used for later API calls.

Step arrow right iconStep 2: Send the direct inventory update event request

To send a direct update you need to ensure your data matches the below type. This will be a JSON object with the defined fields populated.

Parameter

Description

Data Type

ref

ref

String

type

The inventory position type

String

productRef

The ref of the variant product associated with the inventory position

String

locationRef

The location ref associated with the inventory position

String

qty

The quantity

Integer

correctedQty

corrected quantity

Integer

inventoryQuantity

Extra optional attributes sent as part of the payload 

JSON

1{
2  "name": "INVENTORY_UPDATE",
3  "accountId": "YOUR_ACCOUNT",
4  "retailerId": "1",
5  "entityRef": "DEFAULT:2",
6  "entityType": "INVENTORY_CATALOGUE",
7  "entitySubtype": "DEFAULT",
8  "rootEntityType": "INVENTORY_CATALOGUE",
9  "rootEntityRef": "DEFAULT:2",
10  "attributes": 
11    { 
12      "inventoryUpdates": 
13      [ 
14        { 
15          "ref" : "testref1",
16          "productRef": "D45",
17          "locationRef": "LOC_MEL",
18          "qty": 350,
19          "correctedQty":0,
20          "type":"DEFAULT" 
21        } 
22      ]
23    }
24}

Language: json

Name: Example payload

Description:

Example inventory payload with no attributes for INVENTORY_UPDATE event . 

How to Implement Enhanced Inventory Attributes in Your Payloads

Author:

Fluent Commerce

Changed on:

18 Sept 2024

Overview

This guide is designed to help you implement the enhanced 

`attributes`
functionality in your inventory payloads. The 
`attributes`
object is a flexible structure that allows you to include a wide range of key-value pairs, including complex JSON objects and arrays. This flexibility enables you to customize the data according to your specific business needs, whether you are managing detailed product information, handling sophisticated supply chain operations, or integrating with custom workflows.

Key points

  • Flexible Attribute Structure: The 
    `attributes`
    object supports any combination of key-value pairs, including complex JSON structures and arrays. This flexibility allows you to customize the data sent in your inventory payloads to meet specific business needs.
  • Recommended Attributes: Certain key attributes, such as 
    `expectedOn`
    , 
    `storageAreaRef`
    , and 
    `condition`
    , are automatically integrated into our platform’s workflows. These fields will be directly updated in the inventory quantity associated with the incoming record, facilitating seamless integration with existing fields.
  • Custom Attribute Availability: Any custom attributes that you include in the 
    `attributes`
    object will be available in workflows via 
    `inventoryPosition.inventoryQuantity.attributes.<fieldname>`
    . This enables you to incorporate custom data into rule-based processes or other logic tailored to your business requirements.
  • ISO 8601 Date Format: For any date-related attributes, it is recommended to use the ISO 8601 format (e.g., 
    `YYYY-MM-DDTHH:MM:SSZ`
    ) to ensure consistency and proper handling within the system.
  • Integration with Workflows: The system is designed to handle both recommended and custom attributes, making them accessible within the workflow context. This ensures that you can leverage these attributes in custom rules and other logic, depending on the specific needs of your implementation.
  • Extensibility: While the table of recommended attributes provides a useful starting point, you are encouraged to extend the 
    `attributes`
    object with any additional fields relevant to your business processes. The flexibility of this structure allows for robust customization.


Leveraging Recommended Attributes

While the 

`attributes`
object gives you the freedom to define and send any custom fields, we recommend using certain key attributes that are optimized for our platform. These recommended fields, such as 
`expectedOn`
, 
`storageAreaRef`
, and 
`condition`
, are automatically integrated into our platform’s inventory management workflows. This means that these fields will be directly updated in the inventory quantity associated with the incoming record, ensuring seamless operation and enhanced performance.

Flexibility for Custom Attributes

Beyond the recommended attributes, you have the flexibility to include additional fields that are specific to your business requirements. Whether you need to send simple key-value pairs, nested JSON structures, or arrays, our system will process these and make them available within the workflow via 

`inventoryPosition.inventoryQuantity.attributes.<fieldname>`
. This allows you to incorporate your custom data into rule-based processes or other logic tailored to your specific business scenarios.

The table below provides examples of the recommended attributes along with their descriptions, usage, and examples. However, you are not limited to these fields—you can extend the 

`attributes`
object with any custom fields that meet your needs. These will be accessible within the workflow for your custom implementations.

Recommended Attributes Table

Attribute Description

Recommended Attribute Key Name

Example

Notes

Specific storage locations in a warehouse.

Use Case :

Optimizing space utilization, reducing retrieval time, and improving warehouse efficiency.

`storageAreaRef`


"LOC1-SR-1"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.storageAreaRef`
and automatically updated in the inventory quantity associated with the incoming record.

Date when new stock is expected.

Use Case :

Planning for space allocation, staffing, and ensuring timely product availability.

`expectedOn`


"2024-10-31T00:00:00.00Z"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.expectedOn`
and automatically updated in the inventory quantity associated with the incoming record. Recommended date format is ISO 8601.

Information on the manufacturing country.

Use Case :

Compliance with import/export regulations, supporting marketing strategies emphasizing local products.

`countryOfOrigin`



"France"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.countryOfOrigin`
and can be used in custom rules.
Alternate field name for this madeIn 

Details like production date and location.

Use Case :

Tracking production details, quality control, and recall management.

`manufacturingBatchInfo`



{ "batchNumber": "BATCH001", "productionDate": "2024-01-15T00:00:00.00Z" }

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.manufacturingBatchInfo`
and can be used in custom rules. Production date should be in ISO 8601 format.

Indicates the last date a product is safe to use.

Use Case :

Managing stock rotation, reducing waste, and ensuring compliance with health and safety regulations.

`expiryDate`


"2025-12-31T23:59:59.00Z"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.expiryDate`
and can be used in custom rules. Recommended date format is ISO 8601.

Unique identifier for each supplier.

Use Case :

Tracking supplier performance, managing vendor relationships, and optimizing supply chain efficiency.

`supplierId`


"SUP12345"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.supplierId`
and can be used in custom rules.

Details on how inventory is quantified.

Use Case:

Ensure consistency in inventory counting, aid in order fulfillment, and simplify stocktaking processes.

`unitOfMeasurement`



"PCS"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.unitOfMeasurement`
and can be used in custom rules.

Unique identifier for high-value items.

Use Case:

Tracking individual items, managing warranties, and enhancing theft prevention.

`serialNumber`


"SN123456789"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.serialNumber`
and can be used in custom rules.

Links inventory to specific purchase orders.

Use Case:

Matching received goods with purchase orders, improving procurement tracking, and enhancing order accuracy.

`purchaseOrderNumber`


"PO987654321"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.purchaseOrderNumber`
and can be used in custom rules.

Source of inventory transfer.

Use Case:

Tracking inventory movement between locations for internal auditing.

`transferFrom`


"STORE01"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.transferFrom`
and can be used in custom rules.

Purpose of the inventory.

Use Case:

Differentiating stock based on its intended use, aiding in inventory accounting and management.

`inventoryPurpose`


"For Sale"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.inventoryPurpose`
and can be used in custom rules.

Indicates the condition of the inventory item.

Use Case:

Managing inventory condition, enabling categorization of items for different sales channels.

`condition`


"NEW"

Available in the workflow via 

`inventoryPosition.inventoryQuantity.attributes.condition `
and automatically updated in the inventory quantity associated with the incoming record.


Example payload with enhanced inventory payload via Batch API ( BPP enabled)

1{
2    "action": "UPSERT",
3    "entityType": "INVENTORY",
4    "source": "SAP_ERP",
5    "event" :"InventoryChanged",
6    "entities": [
7        {
8            "locationRef": "LOC_MEL",
9            "skuRef": "D45",
10            "qty": 350,
11            "correctedQty": 0,
12            "retailerId": 2,
13            "attributes": {
14                "expectedOn": "2024-10-31T00:00:00.00Z", // ISO 8601 format
15                "storageAreaRef": "LOC_MELB_RET2-SR1",
16                "condition": "NEW",
17                "countryOfOrigin": "China",
18                "expiryDate": "2025-12-31T23:59:59.00Z", // ISO 8601 format
19                "supplierId": "SUP12345",
20                "unitOfMeasurement": "PCS",
21                "serialNumber": "SN123456789",
22                "purchaseOrderNumber": "PO987654321",
23                "transferFrom": "STORE01",
24                "inventoryPurpose": "For Sale",
25                "manufacturingBatchInfo": {
26                    "batchNumber": "BATCH001",
27                    "productionDate": "2024-01-15T00:00:00.00Z" // ISO 8601 format
28                }
29                    }
30
31            }
32        
33    ]
34}

Language: json

Name: Example payload with enhanced inventory payload via Batch API

Description:

Example payload with enhanced inventory payload via Batch API


Example payload with enhanced inventory payload for direct updates via INVENTORY_UPDATE event

1
2{
3  "name": "INVENTORY_UPDATE",
4  "accountId": "YOUR_ACCOUNT",
5  "retailerId": "1",
6  "entityRef": "DEFAULT:2",
7  "entityType": "INVENTORY_CATALOGUE",
8  "entitySubtype": "DEFAULT",
9  "rootEntityType": "INVENTORY_CATALOGUE",
10  "rootEntityRef": "DEFAULT:2",
11  "attributes": 
12    { 
13      "inventoryUpdates": 
14      [ 
15        { 
16          "ref" : "testref1",
17          "productRef": "D45",
18          "locationRef": "LOC_MEL",
19          "qty": 350,
20          "correctedQty":0,
21          "type":"DEFAULT" ,
22          "inventoryQuantity": {
23             "attributes": {
24                "expectedOn": "2024-10-31T00:00:00.00Z", // ISO 8601 format
25                "storageAreaRef": "LOC_MELB_RET2-SR1",
26                "condition": "NEW",
27                "countryOfOrigin": "China",
28                "expiryDate": "2025-12-31T23:59:59.00Z", // ISO 8601 format
29                "supplierId": "SUP12345",
30                "unitOfMeasurement": "PCS",
31                "serialNumber": "SN123456789",
32                "purchaseOrderNumber": "PO987654321",
33                "transferFrom": "STORE01",
34                "inventoryPurpose": "For Sale",
35                "manufacturingBatchInfo": {
36                    "batchNumber": "BATCH001",
37                    "productionDate": "2024-01-15T00:00:00.00Z" // ISO 8601 format
38                }
39                    }
40        } 
41      ]
42    }
43}

Language: json

Name: Example payload with enhanced payload for direct updates via INVENTORY_UPDATE event

Description:

Example payload with enhanced payload for direct updates via INVENTORY_UPDATE event

Integration guidelines for Direct Updates with Attributes

Author:

Fluent Commerce

Changed on:

23 Sept 2024

Overview

This document provides guidelines for handling message size limitations when sending inventory updates via the 

`INVENTORY_UPDATE`
event. It highlights the importance of keeping message sizes around 200KB and offers strategies for estimating the number of inventory updates per message. Recommendations for optimizing message content and ensuring efficient integration are also included.

Key points

  • Message size limit: 200KB for inventory update messages.
  • Payload structure: Inventory updates include multiple attributes, which affect message size.
  • Size estimation: Approximately 160-170 updates per message, based on average update size of 1.2KB.
  • Integration strategies: Manage attributes, batch updates effectively, and test thoroughly to ensure proper handling of message size.

Message Size Considerations

When sending inventory updates through the 

`INVENTORY_UPDATE`
event, the message size should be kept around 200KB. This ensures efficient processing and prevents message delivery failures.

Estimating the Number of Inventory Updates per Message

The number of inventory updates that can fit into a single message depends on the size of each update, which varies based on the number and size of the attributes. A typical inventory update, similar to the following sample payload, is approximately 1.2 KB.

Sample Payload Structure:
             

1{
2  "name": "INVENTORY_UPDATE",
3  "accountId": "YOUR_ACCOUNT",
4  "retailerId": "1",
5  "entityRef": "DEFAULT:2",
6  "entityType": "INVENTORY_CATALOGUE",
7  "entitySubtype": "DEFAULT",
8  "rootEntityType": "INVENTORY_CATALOGUE",
9  "rootEntityRef": "DEFAULT:2",
10  "attributes": {
11    "inventoryUpdates": [
12      {
13        "ref": "testref1",
14        "productRef": "D45",
15        "locationRef": "LOC_MEL",
16        "qty": 350,
17        "correctedQty": 0,
18        "type": "DEFAULT",
19        "inventoryQuantity": {
20          "attributes": {
21            "expectedOn": "2024-10-31T00:00:00.00Z",
22            "storageAreaRef": "LOC_MELB_RET2-SR1",
23            "condition": "NEW",
24            "countryOfOrigin": "China",
25            "expiryDate": "2025-12-31T23:59:59.00Z",
26            "supplierId": "SUP12345",
27            "unitOfMeasurement": "PCS",
28            "serialNumber": "SN123456789",
29            "purchaseOrderNumber": "PO987654321",
30            "transferFrom": "STORE01",
31            "inventoryPurpose": "For Sale",
32            "manufacturingBatchInfo": {
33              "batchNumber": "BATCH001",
34              "productionDate": "2024-01-15T00:00:00.00Z"
35            }
36          }
37        }
38      }
39    ]
40  }
41}
42

Language: json

Name: Sample INVENTORY_UPATE payload

Description:

[Warning: empty required content area]

`
`

Estimating Update Size

A typical inventory update like the example above is 1.2 KB. This estimate is based on average-sized strings for fields like 

`refs`
, 
`dates`
, and 
`IDs`
.

Calculating Updates per Message

Given the 200KB size limit, approximately 160-170 inventory updates can be included in a single message, depending on attribute sizes. This estimate includes a small buffer for variability in attribute size.

Recommendations for Integration

  • Dynamic Calculation: Implement a dynamic size calculation in your code to stay within the 200KB limit. The actual number of updates may vary based on the content of each update.
  • Attribute Management:
    • The number and size of attributes impact how many updates fit into a message.
    • Omit null or empty attributes to save space.
    • Use concise attribute names and values where possible.
  • Batching Strategy:
    • Start with batches of 150 updates per message as a safe margin.
    • Monitor for failures and adjust batch sizes accordingly.
    • Be ready to split large batches into multiple messages if necessary.
  • Testing:
    • Test thoroughly with various update sizes and attribute combinations to ensure your integration can handle different scenarios effectively.
Fluent Commerce

Fluent Commerce

Building Blocks
Building Blocks
Packages & Modules
UI Components
Workflows
Settings
Interface Contracts
Rules
By Type
All Types
Knowledge Tracks
Extend Knowledge
Glossary
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
eLearning

Copyright © 2024 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