Inbound | PUT | /usp/inventories/absolute

Summary

This API will be called by any External WMS to update the absolute inventory available in WMS for the Products listed in Increff OMS.

Description

  1. This API will always expect to send the inventory available for sale in external WMS system to Increff OMS system so that the inventory can be exposed to External integrated channels like Marketplaces, Webshops ERP systems etc.
  2. The inventory quantity will always be absolute in nature.

<aside> ℹ️

Note: One batch can contain maximum of 300 SKUs.

</aside>

Request

{
      "locationCode": "wd003",
      "excludeNonDispatchedInventory": false,
      "products": [
          {
              "channelSkuCode": "ITEM302",
              "quantity": 40,
              "batchIdentification": {
                  "batchCode": "BATCH001",
                  "supplierCode": "SUP001",
                  "manufacturingDate": "2024-01-15T00:00:00Z",
                  "expiryDate": "2025-01-15T00:00:00Z"
              }
          }
      ]
  }
Parameter Name Data Type Description Mandatory
locationCode String Identifier for the location for which inventory will be synced to channel. Yes
products Object[] List of products for which inventory needs to be updated Yes
products.channelskuCode String Scannable barcode on the product Yes
products.quantity int Aboluste Quantity of inventory available for the product in external WMS. Yes
products.batchIdentification Object Batch identification details for the product. No
products.batchIdentification.batchCode String Batch code of the product. No
products.batchIdentification.supplierCode String Supplier code for the batch. No
products.batchIdentification.manufacturingDate ZonedDateTime Manufacturing date of the batch. No
products.batchIdentification.expiryDate ZonedDateTime Expiry date of the batch. No

<aside> ⚠️

EFS has to share either the Batch code or the Batch Code + Supplier Code or Manufacturing date + Expiry Date if sharing updates for perishable items.

</aside>

Response

{
    "successProducts": [
      "CHANNEL-SKU-001",
      "CHANNEL-SKU-002"
    ],
    "failureProducts": [],
    "successUspProductsDetails": [
      {
        "channelSkuCode": "CHANNEL-SKU-001",
        "batchCode": "BATCH-001",
        "supplierCode": "SUPPLIER-001",
        "manufacturingDate": "2024-01-01T00:00:00Z",
        "expiryDate": "2025-12-31T23:59:59Z"
      }
    ],
    "failureUspProductsDetails": []
  }
Parameter Name Data Type Description
failureProducts String[] List of channelSkuCode for which inventory update was not successful
successProducts String[] List of channelSkuCode for which inventory update was successful
failureProductsDetails Object Product and batch identification details for which inventory update was not successful, including channelSkuCode, batchCode, supplierCode, manufacturingDate, and expiryDate, where applicable.
successProductsDetails Object Product and batch identification details for which inventory update was successful, including channelSkuCode, batchCode, supplierCode, manufacturingDate, and expiryDate, where applicable.

HttpStatus : 200