Device

Device requests allow you to manage device-specific information and settings for POS terminals, tablets, and other hardware devices connected to the system.

1 - Get Device Info

"Retrieve information about a specific device using its unique identifier."

Request

Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "deviceID": Number
}
            

{
    "requestType": "device",
    "actionType": "getInfo",
    "deviceID": 1
}

See definitions

Response

Definitions Example 

{
    "status": String,
    "deviceInfo": Object
}
            

{
    "status": "OK",
    "deviceInfo": {
        "id": 1,
        "name": "POS Terminal 1",
        "type": "TERMINAL",
        "status": "ACTIVE"
    }
}

See definitions

2 - Save Device Info

"Update or save device information for a specific device."

Request

Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "deviceID": Number,
    "deviceInfo": Object
}
            

{
    "requestType": "device",
    "actionType": "saveInfo",
    "deviceID": 1,
    "deviceInfo": {
        "name": "POS Terminal 1",
        "type": "TERMINAL",
        "location": "Front Counter"
    }
}

See definitions

Response

Definitions Example 

{
    "status": String,
    "deviceInfo": Object
}
            

{
    "status": "OK",
    "deviceInfo": {
        "id": 1,
        "name": "POS Terminal 1",
        "type": "TERMINAL",
        "location": "Front Counter"
    }
}

See definitions

3 - Get Device Settings

"Retrieve device-specific configuration settings."

Request

Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "deviceID": Number
}
            

{
    "requestType": "device",
    "actionType": "getSettings",
    "deviceID": 1
}

See definitions

Response

Definitions Example 

{
    "status": String,
    "config": Object
}
            

{
    "status": "OK",
    "config": {
        "printerEnabled": true,
        "cashDrawerEnabled": true,
        "displayTimeout": 300
    }
}

See definitions

4 - Save Device Settings

"Update device-specific configuration settings."

Request

Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "deviceID": Number,
    "settings": Object
}
            

{
    "requestType": "device",
    "actionType": "saveSettings",
    "deviceID": 1,
    "settings": {
        "printerEnabled": true,
        "cashDrawerEnabled": false,
        "displayTimeout": 600
    }
}

See definitions

Response

Definitions Example 

{
    "status": String
}
            

{
    "status": "OK"
}

See definitions

Definitions

Request Definitions

Definition Type Description
actionType String (["getInfo", "saveInfo", "getSettings", "saveSettings"]) Unique action identifier for your request.
deviceID Number Unique numeric identifier for the device (required for all operations).
deviceInfo Object Device information object containing device properties and metadata.
settings Object Configuration settings object for the device (must be a valid object).

Response Definitions

Definition Type Description
status String Request status.
deviceInfo Object Device information object with current device data.
config Object Device configuration settings object.