Inbound | POST | /inventories

Summary

This API can be used by the client system to fetch Inventory from Increff Omni System for ERP and Marketplace type channels.

Description

This API will be used to fetch inventory details using various parameters.

This API can be used in two ways

  1. By sending a list of channelSkuCodes , system will return the inventory for this list.
    1. One payload can contain upto 10000 skus.
  2. By pageNumber and not sending a list of channelSkuCodes , API returns a paginated response which has to be traversed till response body says hasMore = true.

<aside> 🗣

Note: If the Product listings are not present for the Channel Location passed in the request then the system will throw an error when pageNumber is passed and not list of ChannelSKUCodes

</aside>

Request Body

{
  "locationCode": "wd003",
  "channelSkuCodes": [
    "100565431",
    "100565433",
    "100565435",
    "100565437"
  ],
  "pageNumber": 1
}
Parameter Name Data Type Description Mandatory
locationCode String Code used by channels to identify a warehouse Yes
channelSkuCodes String[] List of channelSkuCodes
(Code used by channel to identify an SKU).
Max Limit is 10000 No
pageNumber Integer If channelSkuCodes list is not sent then pagenumber is mandatory.
pageNumber represents the page number of the paginated response. No

Response Body

{
    "inventories": [
        {
            "channelSkuCode": "100565437",
            "qcPassAvailableQuantity": 100,
            "qcPassAllocatedQuantity": 100,
            "qcPassRecycledQuantity": 2,
            "qcPassLostQuantity": 3,
            "qcPassGrnQuantity": 1,
            "qcPassRejectedQuantity":0,
            "qcFailGrnQuantity": 1,
            "qcFailAvailableQuantity": 20,
            "qcFailRecycledQuantity": 1,
            "qcFailAllocatedQuantity": 0,
            "qcFailRejectedQuantity":0,
            "qcFailLostQuantity": 1
        },
        {
            "channelSkuCode": "100565435",
            "qcPassAvailableQuantity": 100,
            "qcPassAllocatedQuantity": 100,
            "qcPassRecycledQuantity": 2,
            "qcPassLostQuantity": 3,
            "qcPassGrnQuantity": 1,
            "qcPassRejectedQuantity":0,
            "qcFailGrnQuantity": 1,
            "qcFailAvailableQuantity": 20,
            "qcFailRecycledQuantity": 1,
            "qcFailAllocatedQuantity": 0,
            "qcFailRejectedQuantity":0,
            "qcFailLostQuantity": 1
        }
    ],
    "failedChannelSkuCodeList": [
        "100565431",
        "100565433"
    ],
    "hasMore": false
}

HttpStatus : **200**

Parameter Name Data Type Description
inventories Object[] List of inventories
inventories.channelSkuCode String Code used by channel to identify an SKU
inventories.qcPassAvailableQuantity Integer Absolute quantity available for sale in QC PASS status.
inventories.qcPassAllocatedQuantity Integer Absolute QC PASS allocated quantity corresponds to quantity allocated to sales orders which are received but not yet invoiced.
inventories.qcPassRecycledQuantity Integer Absolute QC PASS quantity is the inventory that was either picked up for an order and the order got cancelled OR its taken offline for recycling. This is not available for sale
inventories.qcPassRejectedQuantity Integer If at any SFS node any rejection happens then that much qty is temporarily moved into qcPassRejectedQuantity
This qty will become live again if admin clears them from SF or new inventory updates comes to SFS
inventories.qcPassLostQuantity Integer Absolute QC PASS quantity which has been marked LOST in the warehouse
inventories.qcPassGrnQuantity Integer Abolute QC PASS quantity which is GRNed in warehouse against a purchase order
inventories.qcFailGrnQuantity Integer Abolute QC FAIL quantity which is GRNed in warehouse against a purchase order
inventories.qcFailAvailableQuantity Integer Absolute quantity available for sale in QC FAIL status
inventories.qcFailRecycledQuantity Integer Absolute QC FAIL recycle quantity corresponds to inventory that was either picked up for an order and the order got cancelled OR its taken offline for recycling.
inventories.qcFailAllocatedQuantity Integer Absolute QC FAIL allocated quantity is QC fail quantity allocated against qc fail B2B orders.
inventories.qcFailLostQuantity Integer Absolute QC FAIL quantity which has been marked LOST in the warehouse
inventories.qcFailRejectedQuantity Integer If at any SFS node any rejection happens then that much qty is temporarily moved into qcPassRejectedQuantity
This qty will become live again if admin clears them from SF or new inventory updates comes to SFS
failedChannelSkuCodeList Object[] List of channelSkuCode which are not present.
hasMore Boolean This flag denotes if there are more pages in the response

<aside> ⚠️

  1. This api does not work for virtual combo SKUs.
  2. Available to promise inventory can be calculated by qcPassAvailableQuantity - qcPassAllocatedQuantity - qcPassLostQuantity </aside>