(Consolidated) Available To Promise Inventory

Outbound | PUT | {Client’s URL}

Summary

This API will push the consolidated inventory count to the channel.

When Increff OMS is deciding on routing / splitting this API is to be used as channel does not need information which location has how much inventory.

Description

This api will always send the consolidated inventory available for sale across warehouses/stores.

The inventory will always be absolute.

Note : One batch will contain 200 SKUs. Frequency of this job is configurable in OMS.

In case any store or warehouse inventory is changed, system will trigger 1 consolidated inventory update, which will have consolidatedQuantity representing the sum of qty across all locations. Channels should read this field.

Generally, locationCode and quantity can be ignored. Here quantity defines the qty at the location and locationCode defines the location which caused the inventory change.

consolidationType means weather the consolidated Qty is having both warehouse and store inventory or only stores inventory.

consolidationType STORE is relevant when Increff OMS has to do routing splitting inly for stores.

Request

{
    "consolidationType": "STORE",
    "inventories": [
        {
            "consolidatedQuantity": 36,
            "consolidatedMinExpiry": "2020-10-16",
            "channelSkuCode": "302",
            "channelSerialNo": "456",
            "listingId": 105,
            "quantity": 30,
            "minExpiry": "2020-10-16",
            "locationCode": "loc1",
            "consolidationType": "STORE"
        },
        {
            "consolidatedQuantity": 30,
            "consolidatedMinExpiry": "2020-10-16",
            "channelSkuCode": "301",
            "channelSerialNo": "457",
            "listingId": 106,
            "consolidationType": "STORE"
            "quantity": 30,
            "minExpiry": "2020-10-16",
            "locationCode": "loc1",
            "consolidationType": "STORE"
        }
    ]
}

Parameter Name	Data Type	Description	Mandatory
`consolidationType`	String	Possible values: ALL, STORE ALL means consolidated inventory includes both store and warehouse inventory STORE means consolidated inventory includes only store inventory	yes
`inventories`	Object[]	List of inventories to be updated	Yes
`inventories.consolidatedQuantity`	Integer	Aggregated quantity across all fulfilment locations (In case of consolidationType STORE, aggregated quantity across all stores, whereas in case of ALL, aggregated quantity across all stores and warehouses)	Yes
`inventories.consolidatedMinExpiry`	String	Minimum expiry date of the item across all fulfilment locations	No
`inventories.channelSkuCode`	String	Code used by channel to identify an SKU	Yes
`inventories.channelSerialNo`	String	Additional code by channel to identify an SKU	No
`inventories.listingId`	Integer	The listing id corresponding to the inventory	yes
`inventories.quantity`	Integer	Absolute quantity available for sale in Omni system in location which has triggered the event	No
`inventories.minExpiry`	String	Minimum expiry date of the item guaranteed by Increff Omni	No
`inventories.locationCode`	String	location which has triggered the inventory change event	Yes
`inventories.consolidationType`	String	Possible values: ALL,STORE ALL includes both store and warehouse type fulfilment locations whereas, STORE includes only store type fulfilment locations	Yes

Response

{
    "failureList": [
        {
            "quantity": 30,
            "channelSkuCode": "302",
            "channelSerialNo": "456",
            "minExpiry": "2020-10-16",
            "consolidatedQuantity": "26",
            "consolidatedMinExpiry": "2020-10-16",
            "locationCode": "loc1",
            "listingId": 105,
            "consolidationType": "STORE"
        }
    ],
    "successList": [
        {
            "quantity": 30,
            "channelSkuCode": "301",
            "channelSerialNo": "457",
            "minExpiry": "2020-10-16",
            "consolidatedQuantity": "26",
            "consolidatedMinExpiry": "2020-10-16",
            "locationCode": "loc1",
            "listingId": 106,
            "consolidationType": "STORE"
        }
    ]
}

HttpStatus : 200