Stock Status V3

The Menu Stock Status V3 API provides real-time inventory availability data for menu items.

Overview

Track real-time inventory availability to display accurate stock information and prevent orders for unavailable items. This is a new capability in V3 that enables granular inventory tracking.

API Endpoint

GET /online-ordering/v3/{locationId}/menu/stock-status

Path Parameters:

Response: 200 OK

Response Format

{
  "items": [
    {
      "itemRef": "string",
      "status": "LOW_STOCK"
    },
    {
      "itemRef": "string",
      "status": "OUT_OF_STOCK"
    }
  ]
}

Data Model

Menu Item Stock Status Object

Stock Status Values:

• LOW_STOCK - Item inventory is running low (limited availability)
• OUT_OF_STOCK - Item is currently unavailable (zero inventory)

Implementation Guidelines

Use Cases

• Display real-time inventory status to customers
• Prevent orders for out-of-stock items
• Show warning indicators for low-stock items
• Synchronize inventory across multiple ordering channels

Integration Pattern

1. Fetch menu data using Menu V3 endpoint
2. Fetch stock status using this endpoint
3. Merge stock status with menu items using itemRef
4. Display appropriate indicators in ordering interface
5. Periodically refresh stock status (polling or webhooks)

Best Practices

• Cache stock status with appropriate TTL
• Handle missing items gracefully (assume available if not listed)
• Implement proper error handling for API failures
• Consider using subscriptions for real-time updates
• Update UI dynamically when stock status changes

Key Features

• Real-time stock visibility
• Integration with Menu V3 via item references
• Simple two-state status model
• Lightweight response format
• Supports high-frequency polling

Differences from V2

V2 did not include a dedicated stock status endpoint. This is a new capability in V3 that enables:

• Granular inventory tracking
• Separate inventory updates without full menu refresh
• Better support for high-volume restaurants
• Real-time availability updates