# ClearLine Documentation

## Docs

- [Introduction to API](https://docs.clearline.me/api.md)
- [Get Access Token](https://docs.clearline.me/api-reference/authentication/get-access-token.md): Exchange authorization code for access token, or obtain access token using client credentials.
- [Introduction to Authentication](https://docs.clearline.me/api-reference/authentication/introduction.md): Get your access token in minutes with OAuth 2.0
- [User Login - Authorization Code Flow with PKCE](https://docs.clearline.me/api-reference/authentication/user-login--authorization-code-flow-with-pkce.md): Initiates the OAuth2 Authorization Code flow with PKCE for user authentication. This endpoint is used for **mobile and public clients** that require user consent.
- [Generate carousel URL](https://docs.clearline.me/api-reference/carousel/generate-carousel-url.md): Generates carousel URL for the specified POS system and location.
- [Introduction to Carousel](https://docs.clearline.me/api-reference/carousel/introduction.md): Generate URLs for rotating marketing content displays
- [Lookup coupons, by code](https://docs.clearline.me/api-reference/coupons-v2/lookup-coupons-by-code.md): Search coupons by code
- [Lookup coupons, by keyword](https://docs.clearline.me/api-reference/coupons-v2/lookup-coupons-by-keyword.md): Search coupons by keyword
- [Validate coupon](https://docs.clearline.me/api-reference/coupons-v2/validate-coupon.md): Validate coupon data
- [Get active coupons](https://docs.clearline.me/api-reference/coupons/get-active-coupons.md): Get active coupons by location for the specified POS system.
- [Introduction to Coupons](https://docs.clearline.me/api-reference/coupons/introduction.md): Look up, validate, and apply customer coupons at checkout
- [Search user coupons](https://docs.clearline.me/api-reference/coupons/search-user-coupons.md): Search user coupons by search parameters for the specified POS system.
- [Validate coupon, by transaction](https://docs.clearline.me/api-reference/coupons/validate-coupon-by-transaction.md): Validates a coupon for a POS transaction.
- [Environments](https://docs.clearline.me/api-reference/environments.md)
- [Import products categories to the system](https://docs.clearline.me/api-reference/import/import-products-categories-to-the-system.md)
- [Import products to the system](https://docs.clearline.me/api-reference/import/import-products-to-the-system.md)
- [Import promotions to the system](https://docs.clearline.me/api-reference/import/import-promotions-to-the-system.md)
- [Introduction to Import](https://docs.clearline.me/api-reference/import/introduction.md): Sync your product catalog, categories, and promotions with ClearLine
- [Introduction to Integrations](https://docs.clearline.me/api-reference/integrations/introduction.md): Register new merchant accounts and manage POS integrations
- [Start account registration](https://docs.clearline.me/api-reference/integrations/start-account-registration.md): Starts an account registration based on the existing customer and subscription
- [Get Kiosk menu list](https://docs.clearline.me/api-reference/kiosks/get-kiosk-menu-list.md): Retrieve Kiosk menu list for the specified POS system and terminal.
- [Introduction to Kiosks](https://docs.clearline.me/api-reference/kiosks/introduction.md): Retrieve menu options for self-service kiosk terminals
- [Search loyalty card users](https://docs.clearline.me/api-reference/loyalty-cards-v2/search-loyalty-card-users.md): Search the loyalty card users for the specified POS system and location by keyword.
- [Search loyalty cards](https://docs.clearline.me/api-reference/loyalty-cards-v2/search-loyalty-cards.md): Retrieve loyalty cards for the specified POS system and location.
- [Top-up loyalty card](https://docs.clearline.me/api-reference/loyalty-cards-v2/top-up-loyalty-card.md): Add some amount to the loyalty card for the specified POS system and location.
- [Get loyalty cards](https://docs.clearline.me/api-reference/loyalty-cards/get-loyalty-cards.md): Retrieve loyalty cards for the specified POS system and location.
- [Get user loyalty card details](https://docs.clearline.me/api-reference/loyalty-cards/get-user-loyalty-card-details.md): Retrieve Loyalty Card, User details and Loyalty Program configuration for the specified POS system.
- [Introduction to Loyalty Cards](https://docs.clearline.me/api-reference/loyalty-cards/introduction.md): Manage customer loyalty cards, points, and rewards
- [Interactive API Playground](https://docs.clearline.me/api-reference/openapi-reference.md): Test API endpoints with the interactive playground
- [Get receipt promotion details](https://docs.clearline.me/api-reference/pos-receipt/get-receipt-promotion-details.md): Retrieve promotion details on the receipt for the specified POS system and location.
- [Quick Start Guide](https://docs.clearline.me/api-reference/quick-start.md): Get up and running with the ClearLine API in 5 minutes
- [Introduction to Receipt Promotions](https://docs.clearline.me/api-reference/receipts/introduction.md): Display targeted marketing content on customer receipts
- [Get POS settings](https://docs.clearline.me/api-reference/settings/get-pos-settings.md): Retrieve POS Settings for company's POS ID.
- [Introduction to POS Settings](https://docs.clearline.me/api-reference/settings/introduction.md): Retrieve configuration settings for your POS integration
- [Create POS Transaction](https://docs.clearline.me/api-reference/transactions/create-pos-transaction.md)
- [Introduction to Transactions](https://docs.clearline.me/api-reference/transactions/introduction.md): Send purchase data to ClearLine for loyalty, analytics, and marketing
- [Start POS Interaction](https://docs.clearline.me/api-reference/transactions/start-pos-interaction.md)
- [Get widgets list](https://docs.clearline.me/api-reference/widgets/get-widgets-list.md): Retrieve widgets list for the specified POS system and location
- [Hide widget QR Code](https://docs.clearline.me/api-reference/widgets/hide-widget-qr-code.md)
- [Introduction to Widgets](https://docs.clearline.me/api-reference/widgets/introduction.md): Launch interactive marketing sessions on customer-facing screens
- [Send an email or sms with widget the landing page url](https://docs.clearline.me/api-reference/widgets/send-an-email-or-sms-with-widget-the-landing-page-url.md): Send an email or sms with widget the landing page url
- [Show widget QR Code](https://docs.clearline.me/api-reference/widgets/show-widget-qr-code.md)
- [Start POS widget session](https://docs.clearline.me/api-reference/widgets/start-pos-widget-session.md): Start POS widget session for the specified POS system and location
- [Integration Options](https://docs.clearline.me/integration-options.md)
- [Checkout Integration App](https://docs.clearline.me/integration-options/checkout-integration-app.md)
- [Automated Flow in POS System Checkout](https://docs.clearline.me/integration-options/checkout-integration-app/automated-flow-in-pos-system-checkout.md): Implement fully automated widget triggering based on transaction events
- [CFS Carousel](https://docs.clearline.me/integration-options/checkout-integration-app/cfs-carousel.md): Display marketing slides on customer-facing screens using the Carousel API
- [Checkout Integration Flow Example](https://docs.clearline.me/integration-options/checkout-integration-app/checkout-integration-flow-example.md): Step-by-step guide for integrating ClearLine checkout flow into your POS system
- [Manual Flow in POS System Checkout](https://docs.clearline.me/integration-options/checkout-integration-app/manual-flow-in-pos-system-checkout-cmc.md): Implement manual widget interaction flow in your POS checkout process
- [POS Integration: CFS Web API Events](https://docs.clearline.me/integration-options/checkout-integration-app/pos-integration-cfs-web-api-events-iframe-postmessage.md): Communicate between CFS and POS systems using iframe postMessage events
- [Native CMC + CFS App](https://docs.clearline.me/integration-options/native-cmc-cfs-app.md)
- [Activation Codes](https://docs.clearline.me/integration-options/native-cmc-cfs-app/activation-codes.md)
- [Main Flows and Modes of the Native CMC+CFS App](https://docs.clearline.me/integration-options/native-cmc-cfs-app/main-flows-and-modes-of-the-native-cmccfs-app.md)
- [CFS Only](https://docs.clearline.me/integration-options/native-cmc-cfs-app/main-flows-and-modes-of-the-native-cmccfs-app/cfs-only.md)
- [CMC Only](https://docs.clearline.me/integration-options/native-cmc-cfs-app/main-flows-and-modes-of-the-native-cmccfs-app/cmc-only.md)
- [CMC+CFS Android App Automated Flow](https://docs.clearline.me/integration-options/native-cmc-cfs-app/main-flows-and-modes-of-the-native-cmccfs-app/cmccfs-android-app-automated-flow.md)
- [CMC+CFS Android App Manual Flow](https://docs.clearline.me/integration-options/native-cmc-cfs-app/main-flows-and-modes-of-the-native-cmccfs-app/cmccfs-android-app-manual-flow.md)
- [Native CMC+CFS App Integration Endpoints](https://docs.clearline.me/integration-options/native-cmc-cfs-app/native-cmccfs-app-integration-endpoints.md)
- [Authorization Code Flow with PKCE (User Authorization)](https://docs.clearline.me/pos-integration/authorization-code-flow-with-pkce-user-authorization.md)
- [Client Credentials Grant Authorization (POS Authorization)](https://docs.clearline.me/pos-integration/client-credentials-grant-authorization-pos-authorization.md)
- [Cloud Messaging System Events](https://docs.clearline.me/pos-integration/cloud-messaging-system-events.md)
- [Coupons](https://docs.clearline.me/pos-integration/coupons.md)
- [Coupons Import To CMC](https://docs.clearline.me/pos-integration/coupons-import.md)
- [Coupons sync from CMC to POS](https://docs.clearline.me/pos-integration/coupons/coupons-sync-from-cmc-to-pos.md)
- [Validate Coupon via Transaction](https://docs.clearline.me/pos-integration/coupons/validate-coupon-via-transaction.md)
- [Customers Import To CMC](https://docs.clearline.me/pos-integration/customers-import-to-cmc.md)
- [POS Integration Guides](https://docs.clearline.me/pos-integration/index.md)
- [Loyalty Program](https://docs.clearline.me/pos-integration/loyalty-program.md)
- [New Account Registration](https://docs.clearline.me/pos-integration/new-account-registration.md)
- [POS Receipt Promotion](https://docs.clearline.me/pos-integration/pos-receipt-promotion.md)
- [POS System Settings](https://docs.clearline.me/pos-integration/pos-system-settings.md)
- [Post-purchase transaction to CMC](https://docs.clearline.me/pos-integration/post-purchase-transaction-to-cmc.md)
- [Products Catalog Import to CMC](https://docs.clearline.me/pos-integration/products-catalog-import-to-cmc.md)
- [QR Code Generation](https://docs.clearline.me/pos-integration/qr-code-generation.md): Generate and manage QR codes for customer engagement, digital receipts, loyalty programs, and marketing campaigns
- [SMS / Email Delivery](https://docs.clearline.me/pos-integration/sms-email-delivery.md): Send automated SMS and email messages for receipts, promotions, loyalty updates, and customer engagement
- [SSO](https://docs.clearline.me/pos-integration/sso.md)
- [Quick Set up](https://docs.clearline.me/quick-set-up.md): Connect your POS system, register terminals, and start deploying marketing content
- [Use Cases](https://docs.clearline.me/use-cases.md): Real-world scenarios and implementation examples for ClearLine POS API integration
- [Vocabulary](https://docs.clearline.me/vocabulary.md): Key terms and definitions used throughout the Clearline platform

## OpenAPI Specs

- [openapi](https://docs.clearline.me/openapi.yaml)
- [authentication.openapi](https://docs.clearline.me/authentication.openapi.yaml)