Skip to main content
GET
/
stations
/
{id}
Get station by ID
curl --request GET \
  --url https://integrations.clopos.com/open-api/stations/{id} \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": 123,
    "can_print": true,
    "reminder_enabled": true,
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

​
Purpose

Verifies the status and printing/reminder capabilities of a single station, such as a kitchen, bar, or custom station.

​
HTTP Request

GET https://integrations.clopos.com/open-api/stations/{id}

​
Authorization

Required headers:
  • x-token
  • x-brand
  • x-venue

​
Request Example

curl -X GET "https://integrations.clopos.com/open-api/stations/kitchen" \
  -H "x-token: oauth_example_token" \
  -H "x-brand: openapitest" \
  -H "x-venue": "1"

​
Response

​
200 OK — Station found

{
  "success": true,
  "data": {
    "id": "kitchen",
    "name": "Kitchen",
    "status": 1,
    "can_print": true,
    "reminder_enabled": true,
    "description": "Primary hot line",
    "created_at": "2024-01-20T13:00:00Z",
    "updated_at": "2024-01-20T15:00:00Z"
  },
  "time": 7,
  "timestamp": "2024-01-20T15:15:00Z"
}

​
404 Not Found — Station does not exist

{
  "success": false,
  "error": "resource_not_found",
  "message": "Station not found"
}

​
Field Reference

​
Top-level fields

FieldTypeDescription
successbooleanSuccess status of the request.
dataobjectStation information.
timenumberResponse time.
timestampstringISO 8601 date.

​
Station object

FieldTypeDescription
idstringStation identifier.
namestringStation name.
statusinteger1 = active, 0 = inactive.
can_printbooleanPrinter redirection support.
reminder_enabledbooleanIs terminal reminder feature on?
descriptionstringOptional description.
created_atstringCreation time.
updated_atstringLast update time.

​
Notes

  • The station ID (id) is used for product and printer mapping on the POS side; verify the current restaurant flow before making changes.
  • Stations that return can_print=false are designed only for screen notifications or digital preparation processes.
  • If reminder_enabled is off, terminal users will not receive a warning when closing orders without sending them to the printer; it is recommended to keep it on for critical lines.
  • If a station is not found, it returns 404; selecting a fallback station on the client side or showing a remapping screen to the user provides a good experience.

Authorizations

​
x-token
string
header
required

Access token obtained from /auth endpoint

​
x-brand
string
header
required

Brand identifier

​
x-venue
string
header
required

Venue identifier

Path Parameters

​
id
string
required

Station ID

Response

Station retrieved successfully

​
success
boolean
​
data
object
​
time
integer
​
timestamp
string<date-time>