Documentation Index
Fetch the complete documentation index at: https://docs.clearline.me/llms.txt
Use this file to discover all available pages before exploring further.
Get POS System Settings
Endpoint to get current POS settings.
Before initiating a transaction or any other communication with ClearLine, the POS system must verify whether marketing transactions or other settings are enabled for the specific POS system.
GET https://apitest.clearline.me/v2/pos/{posSystemId}/settings/lookup
| Name | Value | Description |
|---|
| Authorization | Bearer access_token | Request authorization header |
| Content-Type | application/json | Content type |
Input parameters
| Field name | Description |
|---|
| posSystem | The identifier of the POS system (e.g., pax, clover) |
Response
{
"data": {
"companySettings": {
"isCheckInMenuEnabled": true,
"isTransactionsEnabled": true,
"isPosRulesEnabled": true,
"isReceiptPromotionEnabled": true,
"isCouponsEnabled": true,
"isProductsImportEnabled": true
},
"notificationSettings": {
"status": "Enabled",
"channel": "PubNub",
"configuration": {
"publishKey": "pub-c-xxxxxxxxxxxxxxxxxxxxxxxxxx",
"subscribeKey": "sub-c-xxxxxxxxxxxxxxxxxxxxxxxxxx",
"terminalChannel": "pos_system_message-{terminalId}",
"broadcastChannel": "pos_system_message-[all]"
}
}
}
}
Response parameters
| Field name | Description |
|---|
| data | Data Block |
| companySettings | Data Block |
| isCheckInMenuEnabled | Identifies if CheckIn menu is enabled |
| isTransactionsEnabled | Identifies if transaction synchronization enabled on this account |
| isPosRulesEnabled | Identifies if automatic POS Rules enabled on this account |
| isReceiptPromotionEnabled | Identifies if QR code generation enabled to print it on receipts on this account |
| isCouponsEnabled | Identifies if Coupons are enabled |
| isProductsImportEnabled | Identifies if automatic Product Catalog import enabled on this account |
| notificationSettings | Data Block |
| status | Status of notifications [Enabled, Disabled] |
| channel | Identifies the notification channel [None, Webhook, PubNub] |
| configuration | Data Block (PubSub sample) |
| publishKey | Publish key |
| subscribeKey | Subscribe key |
| terminalChannel | Terminal channel, used to send messages to a specific terminal |
| broadcastChannel | Broadcast channel, used to send messages to all terminals on the account |
