Skip to main content
GET
/
v1
/
inventory
Get inventory
curl --request GET \
  --url https://api.sandbox.usenash.com/v1/inventory
{
  "inventory": [
    {
      "id": "<string>",
      "productId": "prod_123",
      "externalProductId": "ext_001",
      "storeLocationId": "store_001",
      "externalStoreLocationId": "ext_store_002",
      "quantity": 50,
      "valueCents": 299,
      "currency": "USD",
      "available": true,
      "location": {
        "aisle": "Produce",
        "bay": "Fruits",
        "shelf": "Bananas"
      },
      "details": {
        "weightedItemInfo": {
          "valueCentsPerMeasurementUnit": 120
        }
      },
      "providerConfigs": [
        {
          "currency": "USD",
          "details": {
            "weightedItemInfo": {
              "valueCentsPerMeasurementUnit": 135
            }
          },
          "provider": "X",
          "serviceType": "pick_and_deliver",
          "valueCents": 299
        }
      ]
    }
  ],
  "totalResults": 123
}

Query Parameters

​
pageIndex
integer
default:0
Required range: x >= 0
Example:

0

​
numResultsPerPage
integer
default:100
Required range: x >= 1
Example:

100

​
search
string | null
Example:

"organic apples"

​
ids
string | null
Example:

"pro_123,pro_456"

​
skus
string | null
Example:

"SKU-001,SKU-002"

​
semanticSearch
string | null
Example:

"fresh fruit for smoothies"

​
externalStoreLocationId
string | null
​
externalProductId
string | null

Response

OK

​
inventory
StoreInventoryOutputSerializer · object[]
required
​
totalResults
integer
required