Skip to main content
POST
/
v2
/
pos
/
{posSystemId}
/
settings
/
lookup
Get POS settings
curl --request POST \
  --url https://public-api-demo.clearline.me/v2/pos/{posSystemId}/settings/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "posCompanyId": "6orMqUyq2Hg3tP"
}
'
{
  "data": {
    "companySettings": {
      "isCheckInMenuEnabled": true,
      "isTransactionsEnabled": true,
      "isPosRulesEnabled": true,
      "isReceiptPromotionEnabled": true,
      "isCouponsEnabled": true,
      "isProductsImportEnabled": true
    },
    "notificationSettings": {
      "status": "Enabled",
      "channel": "None",
      "configuration": {}
    }
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

posSystemId
string
required

POS system id

Body

Request

Request model for POS company settings

posCompanyId
string | null

The company POS identifier

Response

Success

data
object

Pos settings data