/api/v0/inventory/items

A summation of the current inventory state is included, as well as a breakdown on a pre-FC Node basis.

Field	Contents
`totalOnHand`	The total sum of the product inventory within the Spreetail Fulfillment Centers. This includes items that are pending transfer in fulfillment centers. This is calculated as: "totalOnHand" = "totalPending" + "totalAvailable" + "totalFCProcessing" + "totalPendingFCTransfer" + "totalFCQualityControl"
`totalInNetwork`	The total sum of the product inventory within the Spreetail Fulfillment Network. This includes items that are inTransit between fulfillment centers. tottalInNetork = totalOnHand + totalInTransit
`totalOrdersPendingPlanning`	The current count of products that is waiting to be assigned to a Spreetail Fulfillment Center network for processing as a result of a customer order.
`totalPending`	The current count of the products from orders that is waiting to leave the Spreetail Fulfillment Center network as a result of a customer purchase.
`totalAvailable`	Total number of currently sellable pieces for the product. Calculated by the total of Available by Fulfillment Center location summed, minus the network level Orders Pending Planning.
`totalInTransit`	The total number of pieces that are currently in-transit between Spreetail fulfillment centers.
`totalInboundInTransit`	The count of item pieces from the advanced shipping notice that are in transit to the Fulfillment Center.
`totalPendingFCTransfer`	The count of item pieces that are in picking and packing paths for fulfillment center transfer. These units are not considered available inventory. Depending on the internal stage of this process over encumbered orders may reduce this quantity.
`totalFCProcessing`	The count of item pieces that are in fulfillment processes that are removed from Available status but still can be added to available as sellable, this includes internal processes such as bin to bin transfers, bin audits, and more.
`totalFCQualityControl`	The count of item pieces that are in quality process control for fulfillment center investigation. These units are not considered available inventory.
`totalReturnsInProcess`	The count of item pieces that are in returns in receiving and grading process.
`totalPendingReturns`	The count of item pieces that are in returns not yet received. Units in this bucket may or may not be returned by customers, returns not received are removed from this count after 120 days.
`totalReturnDamaged`	The count of item pieces that are in the Fulfillment Center marked as damaged in the customer returns process.
`totalDamaged`	The count of item pieces that are in the Fulfillment Center marked as damaged in receiving or warehouse process.
`totalInboundConfirmed`	The count of item pieces that are in the Fulfillment Center receiving (PO) process that have been confirmed received.
`totalPendingReceiving`	The count of item pieces from the Bill of Lading that are in the Fulfillment Center receiving (PO) process.
`totalLowInventoryWarning`	Identifies if a Fulfillment Center has a low inventory True flag, if all Fulfillment Centers are False, this flag is False.
`locationInventoryDetails`	Contains the detail breakdown of pieces on-hand in a given fulfillment center.
`locationInventoryDetails.locationName`	The short identifier code for the fulfillment center.
`locationInventoryDetails.quantityOnHand`	The number of pieces available at that location.
`locationInventoryDetails.quantityPending`	The current count of the products from orders that is waiting to leave the Spreetail Fulfillment Center network as a result of a customer purchase.
`locationInventoryDetails.quantityInboundInTransit`	The count of item pieces from the advanced shipping notice that are in transit to the Fulfillment Center.
`locationInventoryDetails.quantityPendingReceiving`	The count of item pieces from the Bill of Lading that are in the Fulfillment Center receiving (PO) process.
`locationInventoryDetails.quantityInboundConfirmed`	The count of item pieces that are in the Fulfillment Center receiving (PO) process that have been confirmed received.
`locationInventoryDetails.quantityInTransit`	The total number of pieces that are currently in-transit between Spreetail fulfillment centers. This quantity displayed in this field is for the intended receiving fulfillment Center.
`locationInventoryDetails.quantityPendingFCTransfer`	The count of item pieces that are in picking and packing paths for fulfillment center transfer. These units are not considered available inventory. Depending on the internal stage of this process over encumbered orders may reduce this quantity.
`locationInventoryDetails.quantityPendingReturns`	The count of item pieces that are in returns not yet received. Units in this bucket may or may not be returned by customers, returns not received are removed from this count after 120 days.
`locationInventoryDetails.quantityReturnDamaged`	The count of item pieces that are in the Fulfillment Center marked as damaged in the customer returns process.
`locationInventoryDetails.quantityReturnsInProcess`	The count of item pieces that are in returns in receiving and grading process.
`locationInventoryDetails.quantityFCProcessing`	The count of item pieces that are in fulfillment processes that are removed from Available status but still can be added to available as sellable, this includes internal processes such as bin to bin transfers, bin audits, and more.
`locationInventoryDetails.quantityFCQualityControl`	The count of item pieces that are in quality process control for fulfillment center investigation. These units are not considered available inventory.
`locationInventoryDetails.quantityDamaged`	The count of item pieces that are in the Fulfillment Center marked as damaged in receiving or warehouse process.
`locationInventoryDetails.quantityAvailable`	Total number of currently sellable pieces for the product in a shippable location and state.
`locationInventoryDetails.lowInventoryWarning`	Identifies if a Fulfillment Center has a low inventory True flag, this is based on a minimum quantity and velocity calculation. This calculation Spreetail has created a algorithm that will improve over time.

Sample Data Response

{
  "partNumber": "PRODUCT-SKU",
  "productId": "123456",
  "upc": "123456789012",
  "isBundle": false,
  "totalOnHand": 895,
  "totalOrdersPendingPlanning": 2,
  "totalPending": 5,
  "totalAvailable": 828,
  "totalInNetwork": 995,
  "totalInTransit": 10,
  "totalInboundInTransit": 100,
  "totalPendingFCTransfer": 50,
  "totalFCQUalityControl": 0,
  "totalReturnsInProcess": 0,
  "totalPendingReturns": 0,
  "totalReturnDamaged": 0,
  "totalDamaged": 0,
  "totalInboundConfirmed": 0,
  "totalPendingReceiving": 0,
  "totalLowInventoryWarning": true,
  "totalPendingReceiving": 20,
  "locationInventoryDetails": [
		{
        "locationName": "FC-NAME1",
        "quantityOnHand": 400,
        "quantityPending": 3,
        "quantityInboundInTransit": 0,
        "quantityPendingReceiving": 0,
        "quantityInboundConfirmed": 0,
        "quantityInTransit": 0,
        "quantityPendingFCTransfer": 50,
        "quantityPendingReturns": 0,
        "quantityReturnDamaged": 0,
        "quantityReturnsInProcess": 0,
        "quantityFCProcessing": 0,
        "quantityFCQualityControl": 0,
        "quantityDamaged": 0,
        "quantityAvailable": 347,
        "lowInventoryWarning": False,
		},
		{
        "locationName": "FC-NAME2",
        "quantityOnHand": 400,
        "quantityPending": 2,
        "quantityInboundInTransit": 0,
        "quantityPendingReceiving": 0,
        "quantityInboundConfirmed": 0,
        "quantityInTransit": 0,
        "quantityPendingFCTransfer": 50,
        "quantityPendingReturns": 0,
        "quantityReturnDamaged": 0,
        "quantityReturnsInProcess": 0,
        "quantityFCProcessing": 0,
        "quantityFCQualityControl": 0,
        "quantityDamaged": 0,
        "quantityAvailable": 348,
        "lowInventoryWarning": False,
		},
		{
        "locationName": "FC-NAME3",
        "quantityOnHand": 95,
        "quantityPending": 0,
        "quantityInboundInTransit": 100,
        "quantityPendingReceiving": 0,
        "quantityInboundConfirmed": 0,
        "quantityInTransit": 10,
        "quantityPendingFCTransfer": 0,
        "quantityPendingReturns": 0,
        "quantityReturnDamaged": 0,
        "quantityReturnsInProcess": 0,
        "quantityFCProcessing": 0,
        "quantityFCQualityControl": 0,
        "quantityDamaged": 0,
        "quantityAvailable": 95,
        "lowInventoryWarning": true,
		}
	]
}

Inventory count details are currently updated once every 5 minutes.

Obtaining Inventory Data for a Specific Product

With a combination of the searchIn and searchFor query parameters, it is possible to retrieve inventory data for a single product.

searchIn may contain one of the following:

productId
upc
partNumber

searchFor is the value used to filter the inventory results.