v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB

Store Catalog

Get inventory

List inventory levels with pagination. Filter by external store location ID or external product ID.

get/v1/inventory

Query parameters

pageIndexinteger

numResultsPerPageinteger

Example:100

searchstring nullable

Example:organic apples

idsstring nullable

Example:pro_123,pro_456

skusstring nullable

Example:SKU-001,SKU-002

semanticSearchstring nullable

Example:fresh fruit for smoothies

externalStoreLocationIdstring nullable

externalProductIdstring nullable

Response

totalResultsinteger required

Example response

{
  "inventory": [
    {
      "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
        }
      ]
    }
  ]
}