Checking Item Availability

Introduction

If a merchant is using Sales Restrictions, the Online Ordering API's Item Availability features can be used by integrators to verify if an item is available before creating an order.

This helps prevent online order failure due to restricted items being out of stock.

Important Note

This feature requires a minimum Lightspeed Restaurant K-Series POS app version of 25.36 in order to function correctly. Please ensure that the merchant POS app is updated to this version or later to avoid any issues with item availability checks.

Once the app has been updated to a supported version, the stock levels must be manually set in the POS app again to ensure accuracy.

Checking Item Availability

By GET Request

To check the availability of one or more items, you can use the Get Item Availability endpoint. This endpoint allows you to retrieve the current stock level of a specific item, or set of items, by providing up to 50 SKUs in a query parameter.

Request

GET /o/op/1/itemAvailability?businessLocationId=123456789&skus=FT1,24&page=0&size=10

Response

{
    "data": [
        {
            "sku": "FT1",
            "count": 50,
            "updatedAt": "2025-09-17T21:21:53.863Z"
        },
        {
            "sku": "24",
            "count": 50,
            "updatedAt": "2025-09-17T21:25:14.405Z"
        }
    ],
    "metadata": {
        "current": {
            "page": 0,
            "pageSize": 2
        },
        "total": 2,
        "totalPages": 1,
        "warnings": []
    }
}

By POST Request

You can also check the availability of multiple items by sending a POST request to the Get Item Availability by POST endpoint, with a list of up to 100 SKUs in the request body. This is useful when you want to check the availability of a large number of items at once.

Request

POST /o/op/1/itemAvailability?businessLocationId=123456789&page=0&size=2
{
  "skus": [
    "FT1",
    "24"
  ]
}

Response

{
    "data": [
        {
            "sku": "FT1",
            "count": 50,
            "updatedAt": "2025-09-17T21:21:53.863Z"
        },
        {
            "sku": "24",
            "count": 50,
            "updatedAt": "2025-09-17T21:25:14.405Z"
        }
    ],
    "metadata": {
        "current": {
            "page": 0,
            "pageSize": 2
        },
        "total": 2,
        "totalPages": 1,
        "warnings": []
    }
}