GET Single Item Inventory Across Ship Nodes

How to Use GET Single Item Inventory Across Ship Nodes

This read request allows the supplier to search for an item and view its inventory across multiple ship nodes. This response also includes two new attributes: availToSellQty (available quantity to sell) and reservedQty (reserved quantity). These attributes are important because there can be a delay when an item is shipped to a customer following an order. If suppliers check inventory levels during this time, the item promised to the customer will be included as part of the total inventory count, even though it is unavailable to sell.

This request provides suppliers with inventory levels visible across multiple attributes, such as:

  • inputQty (on-hand inventory): The item inventory quantity as total inventory, factoring in both availToSellQty and reservedQty.
  • availToSellQty (available quantity to sell): The number of items available to sell to a customer.
  • reservedQty (reserved quantity): The number of items already ordered by customers but not yet shipped.

A supplier using this request must specify the individual item they are looking for and the product ID type (productIdType) of that identifier.

Examples:

Call 1: Search for a given global trade vending number (GTIN) for all ship nodes. For example:

GET v3/inventories/05521698385361?productIdType=GTIN

Call 2: Search for a given stock keeping unit (SKU) for all ship nodes. For example:

GET v3/inventories/WkCevhbEi3fSx4y?productIdType=SKU

Call 3: Search for a given global trade vending number (GTIN) across a specified ship node. For example:

GET v3/inventories/05521698385361?&productIdType=GTIN&shipNode=721407