Skip to main content

Checking Online Order Readiness

Introduction​

Use the readiness endpoint to retrieve the latest online ordering readiness state for a business location.

Endpoint: Get Online Order Readiness

Request​

GET /o/op/1/onlineOrderReadiness?businessLocationId=123456789

Query Parameters​

  • businessLocationId (integer, required): The business location to check.

Response Fields​

status​

Overall readiness status:

  • READY
  • NOT_READY

lastUpdatedAt​

Timestamp of the latest readiness update in ISO 8601 format.

onlineOrderingApiConfiguration​

  • enabled (boolean): Indicates whether the Online Ordering API integration is enabled in Back Office for the business location. If false, readiness will be NOT_READY.
  • orderProfileId (integer or null): The order profile used for online ordering at this location. This can be null when no profile is configured.
  • staffId (integer or null): The staff record used by the integration for order creation at this location. This can be null when no staff mapping is configured.

posStatus​

  • salesPeriod (OPENED or CLOSED): Shows whether the location currently has an open sales period.
  • acceptingOnlineOrders (boolean): Indicates whether the location is currently configured in POS to accept online orders.
  • availableDevices (boolean): Indicates whether at least one POS device is currently available for the location (online and running in foreground, with the Lightspeed app open).

Sample Responses​

READY​

{
  "status": "READY",
  "lastUpdatedAt": "2025-12-11T07:27:47.407Z",
  "onlineOrderingApiConfiguration": {
    "enabled": true,
    "orderProfileId": 123456,
    "staffId": 789012
  },
  "posStatus": {
    "salesPeriod": "OPENED",
    "acceptingOnlineOrders": true,
    "availableDevices": true
  }
}

NOT_READY​

{
  "status": "NOT_READY",
  "lastUpdatedAt": "2026-03-03T10:02:00Z",
  "onlineOrderingApiConfiguration": {
    "enabled": false,
    "orderProfileId": null,
    "staffId": null
  },
  "posStatus": {
    "salesPeriod": "CLOSED",
    "acceptingOnlineOrders": false,
    "availableDevices": false
  }
}

Common Responses​

  • 200: Readiness state returned.
  • 400: Invalid request (for example, missing businessLocationId).
  • 401 / 403: Authentication or authorization issue.
  • 404: No readiness state exists for the specified location.

Notes​

  • The endpoint always returns the latest computed state.
  • If you rely on webhooks, use this endpoint for reconciliation on startup or after downtime.