Waiter Call

Purpose

Allows integrators to notify restaurant staff at a specific table — either to request a waiter or to initiate a payment with a chosen payment method.

HTTP Request

POST https://integrations.clopos.com/open-api/v2/waiter-call

This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses.

Module Requirement

This endpoint requires the restaurant_emenu module to be enabled for your brand. Requests made without this module active will return the standard “module not available” error.

Request Body

integer

required

The ID of the table for which the call is being triggered. Must correspond to an existing table in the venue.

string

required

The type of call to trigger. Accepted values:

WAITER — notify staff that a waiter is needed at the table
PAY — request payment for the table

integer

The payment method ID to use when type is PAY. Must be the default CASH or CARD payment method configured for the venue.

payment_method is required when type is PAY and must not be sent for type WAITER.

Request Example

curl --location 'https://integrations.clopos.com/open-api/v2/waiter-call' \
  -H 'x-token: oauth_example_token' \
  -H 'Content-Type: application/json' \
  -d '{
        "table_id": 5,
        "type": "WAITER"
      }'

curl --location 'https://integrations.clopos.com/open-api/v2/waiter-call' \
  -H 'x-token: oauth_example_token' \
  -H 'Content-Type: application/json' \
  -d '{
        "table_id": 5,
        "type": "PAY",
        "payment_method": 1
      }'

// WAITER call
const response = await fetch('https://integrations.clopos.com/open-api/v2/waiter-call', {
  method: 'POST',
  headers: {
    'x-token': 'oauth_example_token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    table_id: 5,
    type: 'WAITER'
  })
});

// PAY call
const payResponse = await fetch('https://integrations.clopos.com/open-api/v2/waiter-call', {
  method: 'POST',
  headers: {
    'x-token': 'oauth_example_token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    table_id: 5,
    type: 'PAY',
    payment_method: 1
  })
});

const data = await response.json();

import requests

url = "https://integrations.clopos.com/open-api/v2/waiter-call"
headers = {
    "x-token": "oauth_example_token",
    "Content-Type": "application/json"
}

# WAITER call
payload = {
    "table_id": 5,
    "type": "WAITER"
}

# PAY call
# payload = {
#     "table_id": 5,
#     "type": "PAY",
#     "payment_method": 1
# }

response = requests.post(url, headers=headers, json=payload)
result = response.json()

Response

200 OK — Call triggered successfully

{
  "success": true
}

400 Bad Request — Validation or creation failure

Returned when the request body is invalid (e.g. unknown table_id, unsupported type, missing payment_method for a PAY call, or invalid payment method ID).

{
  "success": false
}

Overview

Auth

Venues

Users

Customers

Categories

Station

Products

Price Lists

Sales

Orders

Receipts

Inventory

Finance

Tables

Purpose

HTTP Request

Module Requirement

Request Body

Request Example

Response

200 OK — Call triggered successfully

400 Bad Request — Validation or creation failure

​Purpose

​HTTP Request

​Module Requirement

​Request Body

​Request Example

​Response

​200 OK — Call triggered successfully

​400 Bad Request — Validation or creation failure

Purpose

HTTP Request

Module Requirement

Request Body

Request Example

Response

200 OK — Call triggered successfully

400 Bad Request — Validation or creation failure