Search Inventory API (Storefront channels)

Inbound | POST | /inventories/search-sku

Summary

API to search for all locations where a product is available for customer to place order or pickup from store.

Description

The API will accept the list of SKUs as input and return the total inventory available in each fulfillment location (warehouse or store) for the SKU List.
This API can be used to improve the pre-order delivery experience at the front-end system for the end customer.
This API can also be used to show the pickup location of store to end customer in case he chooses the option of buy online and pickup from store (BOPIS) on front end website at time of placing the order

Request

{
  "channelSkuCodes": [
    "100565431",
    "100565433",
    "100565435",
    "100565437"
  ]
}

Parameter Name	Data Type	Description	Mandatory
`channelSkuCodes`	String	Represents channel SKU codes of the product which are listed in Increff systems under channel listings	Yes

Response

{
  "successList": [
    {
      "channelSkuCode": "100565431",
      "channelSerialNo": "100565431",
      "totalQuantity": 280,
      "inventories": [
        {
          "quantity": 140,
          "locationCode": "Store-1",
          "locationType": "Store"
        },
        {
          "quantity": 140,
          "locationCode": "Store-2",
          "locationType": "Store"
        }
      ]
    },
    {
      "channelSkuCode": "100565433",
      "channelSerialNo": "100565433",
      "totalQuantity": 240,
      "inventories": [
        {
          "quantity": 240,
          "locationCode": "wd003",
          "locationType": "Warehouse"
        }
      ]
    }
  ],
  "failureList": [
    "100565435",
    "100565437"
  ]
}

Parameter Name	Data Type	Description
`successList`	List of Inventory data	List of inventory data for the sku
`successList.channelSkuCode`	String	Represents channel SKU codes of the products listed under listings section in Increff system
`successList.channelSerialNo`	String	Represents channel serial number
`successList.totalQuantity`	Integer	Represents total quantity of SKU available of the products listed under listings section in Increff system
`successList.inventories`	Object
`successList.inventories.quantity`	Integer	Total available inventory quantity available for sale in a fulfillment location (store or warehouse)
`successList.inventories.locationCode`	String	Location code which is used by front end system to identify the inventory updates and pushing customer orders to Increff system
`successList.inventorieslocationType`	String	Location Type defines whether the fulfillment location is a Store or Warehouse
`failureList`	List<String>	List of failed SKUs for which inventory cannot be searched

HTTP status