Inventory Update Flow

Step 1. VinculumInventoryEndpoint POST API will receive data like below from WMS (WMSInventoryService) and will push this data into the TaskQueue

{
    "inventoryList": [
        {
            "productId": "SHTFG7FFYC2J3YB7",
            "parentId": null,
            "sku": "GREENTSHIRT_LARGE",
            "variantId": "GREENTSHIRT_LARGE",
            "inventory": "96",
            "locationInventory": "96",
            "changeInStock": 0,
            "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9"
        },
        {
            "productId": "TYUFG7FFYC2J3YB7",
            "parentId": null,
            "sku": "GREENTSHIRT_MEDIUM",
            "variantId": "GREENTSHIRT_MEDIUM",
            "inventory": "50",
            "locationInventory": "10",
            "changeInStock": 0,
            "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9"
        }
    ],
    "account_id": 124,
    "account_slug": "coverstory",
    "externalWmsChannelName": "MYNTRA_PREPROD_TEST",
    "externalWmsAccount": "eshopbox",
    "externalWarehouseID": "FSL4",
    "externalChannelID": "CH0566",
    "connectionId":"51",
    "message_id":123456789
    "channelSlug": null,
    "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9",
    "publishedAt": "2020-07-21 19:49:47"
}

Step 2. Now use ConnectionId to fetch ApiOwner, ApiKey and Vinculum Store Name from the connectionDetails method (Either from Cache or from Database)

Using the below query, fetch APIOwner, APIKey, Vinculum Store Name can be generated

Now fetch Required Details from the below query:

SELECT
        accessToken,
        inputFields,
        refreshToken,
        isActive 
    FROM
        ie_appinstall_connection 
    WHERE
        id = {{connectionId}}

accessToken

inputFields

refreshToken

isActive

{

"store_name": "kalkifashion",

"APIkey":"131524d28b8d4f3fb6746d5f531dfac1c0edfbffe99d4954bd2f564","APIowner":"kalki"

}

active

Once the required details are generated, store them into the Cache Memory in the format given below.

{
    "connectionDetails_{{connectionId}}": {
        "input_fields": {
          "store_name": "kalkifashion",
          "APIkey":"131524d28b8d4f3fb6746d5f531dfac1c0edfbffe99d4954bd2f564",
          "APIowner":"kalki"
         },
        "accessToken": "",
        "isActive": "active",
        "refreshToken": ""
    }
}

Step 3. We need to make a POST WHInventory API call to get the committedQty for each SKU so that it can be added to `inventoryList[].locationInventory` because if locationInventory is less than the committedQty for an SKU, then inventory update gets failed.

POST INVENTORY API:

https://kalkifashion.vineretail.com/RestWS/api/eretail/v4/stock/getWhInventory

Request :

curl --location --request POST 'https://kalkifashion.vineretail.com/RestWS/api/eretail/v4/stock/getWhInventory' \
--header 'ApiOwner: Kalki' \
--header 'ApiKey: 131524d28b8d4f3fb6746d5f531dfac1c0edfbffe99d4954bd2f564' \
--header 'Authorization: Basic TWF5dXI6RXNob3BrYWxraUAxMjM0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "skuCodes": [
        "GREENTSHIRT_LARGE","GREENTSHIRT_MEDIUM"
    ],
    "buckets":["good"],
    "locCode":"TSW",
    "pageNumber": "1"
}'

Response: 200 OK

{
    "responseCode": 0,
    "responseMessage": "Success",
    "hasMore": false,
    "response": [
        {
            "skuCode": "GREENTSHIRT_LARGE",
            "location": "TSW",
            "qty": 5.000,
            "bucket": "Good",
            "committedQty": 7.000
        },
        {
            "skuCode": "GREENTSHIRT_MEDIUM",
            "location": "TSW",
            "qty": 48.000,
            "bucket": "Good",
            "committedQty": 2.000
        }
    ]
}

For ex: if GREENTSHIRT_LARGE` has the following inventory:

Note: Now if the inventoryList[].locationInventory is less than the committedQty of the SKU, in this case, then we will get the following Response:

Request:

curl --location --request POST 'https://kalkifashion.vineretail.com/RestWS/api/eretail/v2/stock/updateInventory' \
--header 'Authorization: Basic TWF5dXI6RXNob3BrYWxraUAxMjM0' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'RequestBody={
    "inventoryList": [
        {
            "skuCode": "GREENTSHIRT_LARGE",
            "qty": 6,
            "bin": "GOOD",
            "reason": "MISC",
            "mode": "New",
            "location": "TSW"
        }
    ]
}' \
--data-urlencode 'ApiOwner=Kalki' \
--data-urlencode 'ApiKey=131524d28b8d4f3fb6746d5f531dfac1c0edfbffe99d4954bd2f564'

Response: 200 OK

{
    "responseCode": 0,
    "responseMessage": "Success",
    "requestStatus": {
        "uniqueKey": "GREENTSHIRT_LARGE",
        "requestKey": "GREENTSHIRT_LARGE",
        "outputKey": null,
        "status": "Error",
        "errorDesc": "Insufficient Inventory."
    }
}

Note: Now if we want to update inventoryList[].locationInventory is more than the committedQty, in this case, let's try to update 10. then we will get the following Response:

Request:

curl --location --request POST 'https://kalkifashion.vineretail.com/RestWS/api/eretail/v2/stock/updateInventory' \
--header 'Authorization: Basic TWF5dXI6RXNob3BrYWxraUAxMjM0' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'RequestBody={
    "inventoryList": [
        {
            "skuCode": "GREENTSHIRT_LARGE",
            "qty": 10,
            "bin": "GOOD",
            "reason": "MISC",
            "mode": "New",
            "location": "TSW"
        }
    ]
}' \
--data-urlencode 'ApiOwner=Kalki' \
--data-urlencode 'ApiKey=131524d28b8d4f3fb6746d5f531dfac1c0edfbffe99d4954bd2f564'

Response: 200 OK

{
    "responseCode": 0,
    "responseMessage": "Success",
    "requestStatus": {
        "uniqueKey": "GREENTSHIRT_LARGE",
        "requestKey": "GREENTSHIRT_LARGE",
        "outputKey": null,
        "status": "Success",
        "errorDesc": null
    }
}

Screenshot:

Step 4. Once we have fetched the required configuration details, we need to extract the SKU details present in the WMS Inventory event in inventoryList and map them with Vinculum Inventory Update API. We can update up to 100 SKU Inventory at once.

Note: Inventory updates depend upon the value `mode` as specified below:

Increase: This value will be used if we need to increase the count of inventory available on the vinculum store.
Decrease: This value will be used if we need to decrease the count of inventory available on the vinculum store.
New: This value will be used if we need to update the absolute count available on the vinculum store.

Mapping of keys from the inventory event to the update inventory API:

Vinculum Inventory Update API Keys	WMS Inventory Update Keys

Vinculum Inventory Update API Keys	WMS Inventory Update Keys
`skuCode`	`inventoryList[].variantId`
`qty`	`WHInventory.response[].committedQty + inventoryList[].locationInventory`
`bin`	`good`
`reason`	`misc`
`mode`	`NEW`
`location`	`inventoryList[].locationId`

After Transformation, the request will be as follows:

curl --location --request POST 'https://kalkifashion.vineretail.com/RestWS/api/eretail/v2/stock/updateInventory' \
--header 'Authorization: Basic TWF5dXI6RXNob3BrYWxraUAxMjM0' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'RequestBody={
    "inventoryList": [
        {
            "skuCode": "GREENTSHIRT_LARGE",
            "qty": 96,
            "bin": "GOOD",
            "reason": "MISC",
            "mode": "New",
            "location": "GGN"
        },
        {
            "skuCode": "GREENTSHIRT_MEDIUM",
            "qty": 10,
            "bin": "GOOD",
            "reason": "MISC",
            "mode": "New",
            "location": "GGN"
        }
    ]
}' \
--data-urlencode 'ApiOwner=Kalki' \
--data-urlencode 'ApiKey=131524d28b8d4f3fb6746d5f531dfac1c0edfbffe99d4954bd2f564'

Response: 200 OK

{
    "responseCode": 0,
    "responseMessage": "Success",
    "requestId": "4b521c7201ed4a76a6f9defe2f134f47"
}

Response: 200 OK

Note: In case when the locationID given in the request does not have the required permission

{
    "responseCode": 3051,
    "responseMessage": "No Access for given location."
}

Apps and Automations

Inventory Update Flow

Step 1. VinculumInventoryEndpoint POST API will receive data like below from WMS (WMSInventoryService) and will push this data into the TaskQueue

Step 2. Now use ConnectionId to fetch ApiOwner, ApiKey and Vinculum Store Name from the connectionDetails method (Either from Cache or from Database)

Step 3. We need to make a POST WHInventory API call to get the committedQty for each SKU so that it can be added to `inventoryList[].locationInventory` because if locationInventory is less than the committedQty for an SKU, then inventory update gets failed.

Note: Now if the inventoryList[].locationInventory is less than the committedQty of the SKU, in this case, then we will get the following Response:

Note: Now if we want to update inventoryList[].locationInventory is more than the committedQty, in this case, let's try to update 10. then we will get the following Response:

Step 4. Once we have fetched the required configuration details, we need to extract the SKU details present in the WMS Inventory event in inventoryList and map them with Vinculum Inventory Update API. We can update up to 100 SKU Inventory at once.

Note: Inventory updates depend upon the value `mode` as specified below:

After Transformation, the request will be as follows:

Related content

Inventory Update Flow

Step 1. VinculumInventoryEndpoint POST API will receive data like below from WMS (WMSInventoryService) and will push this data into the TaskQueue

Step 2. Now use ConnectionId to fetch ApiOwner, ApiKey and Vinculum Store Name from the connectionDetails method (Either from Cache or from Database)

Step 3. We need to make a POST WHInventory API call to get the committedQty for each SKU so that it can be added to inventoryList[].locationInventory because if locationInventory is less than the committedQty for an SKU, then inventory update gets failed.

Note: Now if the inventoryList[].locationInventory is less than the committedQty of the SKU, in this case, then we will get the following Response:

Note: Now if we want to update inventoryList[].locationInventory is more than the committedQty, in this case, let's try to update 10. then we will get the following Response:

Step 4. Once we have fetched the required configuration details, we need to extract the SKU details present in the WMS Inventory event in inventoryList and map them with Vinculum Inventory Update API. We can update up to 100 SKU Inventory at once.

Note: Inventory updates depend upon the value mode as specified below:

After Transformation, the request will be as follows:

Related content

Step 3. We need to make a POST WHInventory API call to get the committedQty for each SKU so that it can be added to `inventoryList[].locationInventory` because if locationInventory is less than the committedQty for an SKU, then inventory update gets failed.

Note: Inventory updates depend upon the value `mode` as specified below: