v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB

Order and Pay

Online Ordering API Readiness Notification

What your webhook implementation will receive when online ordering API readiness is updated. See the Online Order Readiness guide for setup and integration details.

postWebhookapeOnline Ordering API Readiness notification

Payload

businessLocationIdinteger required

The unique identifier for the business location.

lastUpdatedAtstring date-time required

The timestamp when the online order readiness was last updated

status'READY' | 'NOT_READY' required

The readiness status of the online ordering api

typestring required

Notification type

Example payload

{
  "businessLocationId": 45454565682155,
  "lastUpdatedAt": "2025-10-04T09:40:00.000+00:00",
  "status": "READY",
  "type": "ORDER_API",
  "onlineOrderingApiConfiguration": {
    "enabled": true,
    "orderProfileId": 25769803781,
    "staffId": 3
  },
  "posStatus": {
    "salesPeriod": "OPENED",
    "acceptingOnlineOrders": true,
    "availableDevices": true
  }
}

Response

Your server returns this code if it accepts the callback