Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Store Catalog

Create or update inventory

Create or update inventory levels for products at specific store locations. Links products to store locations with quantity and availability information.

post/v1/inventory

Request body

Example request

{
  "inventory": [
    {
      "externalProductId": "ext_001",
      "externalStoreLocationId": "store_001",
      "quantity": 50,
      "valueCents": 299,
      "currency": "USD",
      "available": true,
      "location": {
        "aisle": "Aisle 5",
        "bay": "Bay 3",
        "shelf": "Shelf 2"
      },
      "details": {
        "weightedItemInfo": {
          "valueCentsPerMeasurementUnit": 120
        },
        "taxPercentage": 0.1
      },
      "providerConfigs": [
        {
          "currency": "USD",
          "details": {
            "weightedItemInfo": {
              "valueCentsPerMeasurementUnit": 135
            }
          },
          "discount": {
            "endTime": "2025-12-17T00:00:00Z",
            "startTime": "2025-12-10T00:00:00Z",
            "valueCents": 270
          },
          "provider": "X",
          "serviceType": "pick_and_deliver",
          "valueCents": 299
        }
      ]
    }
  ]
}

Response

OK

idstring required
productIdstring required

The product ID associated with this inventory item

externalProductIdstring nullable

The external product ID from an external system

storeLocationIdstring required

The store location ID where this inventory is located

externalStoreLocationIdstring nullable

The external store ID from an external system

quantityinteger required

The quantity of the product in stock

valueCentsinteger nullable

The price of the product in cents

currencystring nullable

The currency code for the product price

availableboolean required

Whether the product is available for purchase

Example response

[
  {
    "productId": "prod_123",
    "externalProductId": "ext_001",
    "storeLocationId": "store_001",
    "externalStoreLocationId": "ext_store_002",
    "quantity": 50,
    "valueCents": 299,
    "currency": "USD",
    "available": true,
    "location": {
      "aisle": "Aisle 5",
      "bay": "Bay 3",
      "shelf": "Shelf 2"
    },
    "details": {
      "weightedItemInfo": {
        "valueCentsPerMeasurementUnit": 120
      },
      "taxPercentage": 0.1
    },
    "providerConfigs": [
      {
        "currency": "USD",
        "details": {
          "weightedItemInfo": {
            "valueCentsPerMeasurementUnit": 135
          }
        },
        "discount": {
          "endTime": "2025-12-17T00:00:00Z",
          "startTime": "2025-12-10T00:00:00Z",
          "valueCents": 270
        },
        "provider": "X",
        "serviceType": "pick_and_deliver",
        "valueCents": 299
      }
    ]
  }
]