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": {
        "weighted_item_info": {
          "value_cents_per_measurement_unit": 120
        }
      }
    }
  ],
  "totalResults": 123
}

Query Parameters

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

0

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

100

​
externalStoreLocationId
string | null
​
externalProductId
string | null

Response

200
application/json

OK

The response is of type object.