Get all item inventories for all ship nodes (BETA)

To find out entire current inventory for multiple seller’s items at all fulfillment centers, (i.e. ship nodes), use the Multiple Item Inventory for All Ship Nodes API.

For each item, the API returns the ship node ID with seller’s input quantity for the item, the available to sell quantities and reserved quantities.

The inputQty represents total item inventory including items that are sold but not yet shipped.

The availToSellQty represents the inventory that can be allocated to orders. Any items that are sold but not yet shipped will not show up in this count.

The reservedQty represents the count of items that are sold but not yet shipped.

You can use this API to get the first ten items, more than 10, up to 50 items, or do several API calls to get 50 items at a time:

  • Option 1 – Return list of 10 items. Do not specify any query parameters. By default, the API returns 10 items per response, with a maximum allowed 50 items.
  • Option 2 – Return list of more than 10 items, max of 50 items. Specify limit=50 query parameter.
  • Option 3 – Return entire list of items, 50 items per call. Use nextCursor to indicate pagination for each set of 50 items.

Option 1: Retrieve 10 items at all ship nodes

To get a list of the first 10 items across all ship nodes, call /v3/inventories without any query parameters. The API sets the default limit to 10, and returns only 10 item SKUs with their ship node IDs and inventory quantities.

The API response returns the first 10 items, and for each ship node, the inputQty, availToSellQty and reservedQty amounts.

Option 2: Retrieve more than 10 items returned

To specify a specific number of SKUs you want returned in the inventory list, use the limit query parameter. You can request up to 50 items.

For example, to get the first 23 item SKUs, Call /v3/inventories?limit=23 and the API returns the first 23 item inventory entries in the response.

The response returns the inventory count for all of the seller’s items across all ship nodes mapped to the items.

For an example response, see Response Samples in the Multiple Item Inventory for All Ship Nodes API Reference.

Option 3: Use pagination “nextCursor” to get next 50 items

The maximum number of items returned per call is 50. If you would like to get the next 50 items, you need to indicate the pagination with nextCursor parameter.

When you make the initial API call to get maximum items 50, the response returns a string for nextCursor. You need to specify this random string in the next API call.

For example:

  1. Make the first API call to request the first 50 items. For example:
    /v3/inventories?limit=50
    The response returns the nextCursor string to indicate the next page to start after 50 items:
    "nextCursor": "NTVmZjIxOWEtZjRkMy00MGIwLThkOGYtYzFkNzI1NGZlYmQxIDEw"
  2. Make the next call to get the next 50 items.:
    /v3/inventories?nextCursor=NTVmZjIxOWEtZjRkMy00MGIwLThkOGYtYzFkNzI1NGZlYmQxIDEw

The response returns the next 50 items with inventory details.