Skip to main content

​
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 /v2/pos//settings/lookup

​
Headers

NameValueDescription
AuthorizationBearer Request authorization header
Content-Typeapplication/jsonContent type

​
Input parameters

Field nameDescription
posSystemThe 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 nameDescription
dataData Block
companySettingsData Block
isCheckInMenuEnabledIdentifies if CheckIn menu is enabled
isTransactionsEnabledIdentifies if transaction synchronization enabled on this account
isPosRulesEnabledIdentifies if automatic POS Rules enabled on this account
isReceiptPromotionEnabledIdentifies if QR code generation enabled to print it on receipts on this account
isCouponsEnabledIdentifies if Coupons are enabled
isProductsImportEnabledIdentifies if automatic Product Catalog import enabled on this account
notificationSettingsData Block
statusStatus of notifications [Enabled, Disabled]
channelIdentifies the notification channel [None, Webhook, PubNub]
configurationData Block (PubSub sample)
publishKeyPublish key
subscribeKeySubscribe key
terminalChannelTerminal channel, used to send messages to a specific terminal
broadcastChannelBroadcast channel, used to send messages to all terminals on the account