What are POS Settings?
POS settings contain the configuration data that controls how ClearLine integrates with your specific POS system. These settings help you:- Feature Detection: Determine which ClearLine features are enabled for your location
- Loyalty Configuration: Get loyalty program rules, point values, and reward tiers
- Marketing Preferences: Retrieve display options and promotional settings
- Integration Parameters: Access system-specific configuration values
How It Works
Authenticate
Obtain an access token using Client Credentials
flow.
Retrieve Settings
Call the POS settings endpoint
with your POS company ID.
Configure Your Integration
Use the returned settings to enable/disable features and configure your POS
integration behavior.
Settings Endpoint
Get POS Settings
Retrieve configuration settings for a POS company
Best Practices
Cache Settings Appropriately
Cache Settings Appropriately
Cache settings for 15-30 minutes to reduce API calls. Refresh when you
detect a configuration change or at regular intervals.
Handle Missing Features Gracefully
Handle Missing Features Gracefully
Not all features are enabled for every location. Check feature flags in
settings and hide/disable unavailable features in your POS UI.
Validate on Startup
Validate on Startup
Fetch settings when your POS system starts or connects to ClearLine to
ensure you have current configuration data.
Don't Hardcode Configuration
Don't Hardcode Configuration
Always use settings from the API rather than hardcoding values. Settings can
change without requiring a POS software update.