How to send Delta Inventory updates
Author:
Fluent Commerce
Changed on:
9 Oct 2023
Overview
Delta Inventory updates are incremental inventory updates used to create relative updates against Inventory positions. These are used to notify the OMS of offline stock movements that have occurred during the day.
Introduction
Author:
Fluent Commerce
Changed on:
9 Oct 2023
Overview
Delta Inventory updates are incremental inventory updates to create relative updates against Inventory Positions. These are used to notify the OMS of offline stock movements which have happened during the day.
As part of the Inventory Module, we have provided a reference implementation. This includes the workflow JSON, rules, & configurations required to implement delta updates.
Key points
- When you should use Delta Updates
- Capabilities of the platform this process uses
- Supplementary guides
When you should use Delta Updates
Delta updates are best used to notify Order Management of offline stock movements that have happened during a normal day of retail trading.
Eg. if you sell 2 pairs of shoes in-store, you would notify the Order Management via Delta to decrease inventory availability by 2.
Capabilities of the platform this process uses
Capability | Description |
API to send the events against |
Supplementary guides
Guide | Description |
Learn how to send Inventory Updates via events | |
Learn how to use Inventory Batches and follow the suggested best practices |
How the delta updates work
Author:
Fluent Commerce
Changed on:
9 Oct 2023
Key Points
- Authenticate against the Retailer you are sending the delta updates
- Send the delta inventory update event request
Steps
Step 1: Authenticate against the Retailer you are sending the delta updates
For use of authentication please read: Authentication
The returned token will be used for later API calls.
Step 2: Send the delta inventory update event request
Delta updates require certain attributes to be present for the updates to be processed. The table below describes all the possible that need to be included as part of the event.
Parameter | Description | Data Type |
deltaId | The Id of the delta that uniquely identifies this delta element | String |
type | The inventory position type | String |
productRef | The ref of the variant product associated to the inventory position | String |
locationRef | The location ref associated to the inventory position | String |
qty | The quantity | Integer |
1{
2 "name": "INVENTORY_DELTA",
3 "accountId": "FCTRAIN1001",
4 "retailerId": "1",
5 "entityRef": "DEFAULT:1",
6 "entityType": "INVENTORY_CATALOGUE",
7 "entitySubtype": "DEFAULT",
8 "rootEntityType": "INVENTORY_CATALOGUE",
9 "rootEntityRef": "DEFAULT:1",
10 "attributes": {
11 "deltas": [
12 {
13 "productRef": "D45",
14 "locationRef": "LOC_MEL",
15 "qty": -10,
16 "type":"DELTA",
17 "deltaId":"123AT"
18 },
19 {
20 "productRef": "D45",
21 "locationRef": "LOC_MEL",
22 "qty": 20,
23 "type":"DELTA",
24 "deltaId":"123AY"
25 },
26 {
27 "productRef": "D45",
28 "locationRef": "LOC_SYD",
29 "qty": -30,
30 "type":"DELTA",
31 "deltaId":"123AX"
32 }
33 ]
34 }
35}Language: json
Name: Example event payload
Description:
[Warning: empty required content area]
