Docs
Author:
Fluent Commerce staff
Changed on:
3 May 2024
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).
Author:
Fluent Commerce staff
Changed on:
3 May 2024
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.
Direct updates are designed to be used when the number of Inventory updates is quite small, less than 1000 updates. Using direct updates results in quicker processing of inventory vs batch uploads when operating at these lower inventory volumes.
The 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 >1000 updates, the batch should be used.
Capability | Description |
API to send the events against |
Guide | Description |
Learn how to send delta inventory updates via events | |
Learn how to use Inventory Batches and follow the suggested best practices |
Author:
Fluent Commerce staff
Changed on:
3 May 2024
Step 1: Authenticate against the Retailer you are sending the direct updatesFor use of authentication please read: Authentication
The returned token will be used for later API calls.
Step 2: Send the direct inventory update event requestTo 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 to the inventory position | String |
locationRef | The location ref associated to the inventory position | String |
qty | The quantity | Integer |
correctedQty | corrected quantity | Integer |
1{
2 "name": "INVENTORY_UPDATE",
3 "accountId": "FCTRAIN1001",
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":"LAST_ON_HAND"
21 }
22 ]
23 }
24}Language: json
Name: Example payload
Description:
[Warning: empty required content area]
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.
