Get inventory

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/inventory \
  --header 'Authorization: Bearer <token>'

{
  "inventory": [
    {
      "id": "<string>",
      "productId": "prod_123",
      "storeLocationId": "store_001",
      "quantity": 50,
      "available": true,
      "externalProductId": "ext_001",
      "externalStoreLocationId": "ext_store_002",
      "valueCents": 299,
      "currency": "USD",
      "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
}

GET

inventory

Get inventory

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/inventory \
  --header 'Authorization: Bearer <token>'

{
  "inventory": [
    {
      "id": "<string>",
      "productId": "prod_123",
      "storeLocationId": "store_001",
      "quantity": 50,
      "available": true,
      "externalProductId": "ext_001",
      "externalStoreLocationId": "ext_store_002",
      "valueCents": 299,
      "currency": "USD",
      "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
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageIndex

integer

default:0

Required range: x >= 0

Example:

0

numResultsPerPage

integer

default:100

Required range: x >= 1

Example:

100

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

inventory

StoreInventoryOutputSerializer · object[]

required

Show child attributes

inventory.id

string

required

inventory.productId

string

required

The product ID associated with this inventory item

Example:

"prod_123"

inventory.storeLocationId

string

required

The store location ID where this inventory is located

Example:

"store_001"

inventory.quantity

integer

required

The quantity of the product in stock

Example:

50

inventory.available

boolean

required

Whether the product is available for purchase

Example:

true

inventory.externalProductId

string | null

The external product ID from an external system

Example:

"ext_001"

inventory.externalStoreLocationId

string | null

The external store ID from an external system

Example:

"ext_store_002"

inventory.valueCents

integer | null

The price of the product in cents

Example:

299

inventory.currency

string | null

The currency code for the product price

Example:

"USD"

inventory.location

LocationDataOutputSerializer · object

The location data for the product in the store

Show child attributes

inventory.location.aisle

string | null

The aisle location of the product in the store

Example:

"Aisle 5"

inventory.location.bay

string | null

The bay location of the product in the store

Example:

"Bay 3"

inventory.location.shelf

string | null

The shelf location of the product in the store

Example:

"Shelf 2"

Example:

{
  "aisle": "Produce",
  "bay": "Fruits",
  "shelf": "Bananas"
}

inventory.details

StoreInventoryDetailsOutputSerializer · object

Additional inventory details

Show child attributes

inventory.details.weightedItemInfo

StoreInventoryWeightedItemInfoOutputSerializer · object

Weight information per inventory item

Show child attributes

inventory.details.weightedItemInfo.valueCentsPerMeasurementUnit

integer | null

The price per cents per measurement unit

Example:

120

Example:

{
  "weightedItemInfo": { "valueCentsPerMeasurementUnit": 120 }
}

inventory.providerConfigs

InventoryProviderConfigOutputSerializer · object[] | null

Provider-specific configurations for this inventory item

Show child attributes

inventory.providerConfigs.provider

string

required

Provider name

Example:

"X"

inventory.providerConfigs.serviceType

string

required

Service type (e.g., pick_and_deliver, marketplace)

Example:

"pick_and_deliver"

inventory.providerConfigs.valueCents

integer

required

The price of the product in cents for this provider

Example:

299

inventory.providerConfigs.currency

string

required

The currency code for the product price

Example:

"USD"

inventory.providerConfigs.details

StoreInventoryDetailsOutputSerializer · object

Additional pricing details for this provider

Show child attributes

inventory.providerConfigs.details.weightedItemInfo

StoreInventoryWeightedItemInfoOutputSerializer · object

Weight information per inventory item

Show child attributes

inventory.providerConfigs.details.weightedItemInfo.valueCentsPerMeasurementUnit

integer | null

The price per cents per measurement unit

Example:

120

inventory.providerConfigs.enabled

boolean | null

Whether this provider config is enabled

Example:

true

Example:

[
  {
    "currency": "USD",
    "details": {
      "weightedItemInfo": { "valueCentsPerMeasurementUnit": 135 }
    },
    "provider": "X",
    "serviceType": "pick_and_deliver",
    "valueCents": 299
  }
]

totalResults

integer

required

Create or update inventory Server Health Check

⌘I

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Routes

Shifts

Templates

Store Catalog

Miscellaneous

Get inventory

Authorizations

Query Parameters

Response