Skip to main content
POST
/
v1
/
inventory
Create or update inventory
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/inventory \
  --header 'Content-Type: application/json' \
  --data '{
  "inventory": [
    {
      "externalProductId": "ext_001",
      "externalStoreLocationId": "store_001",
      "quantity": 50,
      "valueCents": 299,
      "currency": "USD",
      "available": true,
      "location": {
        "aisle": "Produce",
        "bay": "Fruits",
        "shelf": "Bananas"
      },
      "details": {
        "weightedItemInfo": {
          "valueCentsPerMeasurementUnit": 120
        }
      }
    }
  ]
}'
[
  {
    "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
      }
    }
  }
]

Body

application/json
​
inventory
StoreInventoryInputSerializer · object[]
required

List of store inventory to create or update

Response

OK

Expected output when listing products, it will return an array of StoreInventoryOutputSerializer.

​
id
string
required
​
productId
string
required

The product ID associated with this inventory item

Example:

"prod_123"

​
storeLocationId
string
required

The store location ID where this inventory is located

Example:

"store_001"

​
quantity
integer
required

The quantity of the product in stock

Example:

50

​
available
boolean
required

Whether the product is available for purchase

Example:

true

​
externalProductId
string | null

The external product ID from an external system

Example:

"ext_001"

​
externalStoreLocationId
string | null

The external store ID from an external system

Example:

"ext_store_002"

​
valueCents
integer | null

The price of the product in cents

Example:

299

​
currency
string | null

The currency code for the product price

Example:

"USD"

​
location
object | null

The location data for the product in the store

Example:
{
  "aisle": "Produce",
  "bay": "Fruits",
  "shelf": "Bananas"
}
​
details
object | null

Additional inventory details

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