Inbound | PUT | /usp/inventories/delta

Summary

This API updates inventory quantities using delta (incremental/decremental) values.

Description

This API is used by the External Fulfillment System (EFS) to update inventory quantities using delta values. Unlike absolute inventory updates, delta updates add or subtract from the existing inventory quantities based on the update type. It supports batch-level inventory updates for perishable products.

Request Body

{
  "locationCode": "LOC-001",
  "products": [
    {
      "channelSkuCode": "CHANNEL-SKU-001",
      "quantity": 10,
      "updateType": "INCREMENT",
      "batchIdentification": {
        "batchCode": "BATCH-001",
        "supplierCode": "SUPPLIER-001",
        "manufacturingDate": "2024-01-01T00:00:00Z",
        "expiryDate": "2025-12-31T23:59:59Z"
      }
    },
    {
      "channelSkuCode": "CHANNEL-SKU-002",
      "quantity": 5,
      "updateType": "DECREMENT",
      "batchIdentification": null
    }
  ]
}
Parameter Name Data Type Description Mandatory
locationCode String Identifier of the fulfillment location Yes
products Array List of products with delta inventory quantities (minimum 1 item) Yes
products.channelSkuCode String Channel SKU code of the product Yes
products.quantity Integer Delta inventory quantity (minimum 0) Yes
products.updateType Enum Type of delta update. Possible values: INCREMENT, DECREMENT Yes
products.batchIdentification Object Batch identification details for perishable products No
products.batchIdentification.batchCode String External batch code 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

Response Body

 {
    "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
successProducts Array[String] List of channel SKU codes for which inventory was successfully updated
failureProducts Array[String] List of channel SKU codes for which inventory update failed

HttpStatus: 200