Fluent Commerce Logo
Docs
Help & Feedback
Sign In

How to Implement Enhanced Inventory Attributes in Your Payloads

Essential knowledge

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

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