Automated Flow in POS System Checkout

Overview

The Automated Flow is designed for fully automated POS system integrations where widget sessions are triggered in real-time based on transaction events—without the need for manual input from the operator. This enables seamless customer engagement during the checkout process.

Check POS Settings

Before starting a transaction, the POS system must check whether marketing transactions are enabled for the specific POS system.

GET https://public-api-test.clearline.me/pos/{posSystem}/settings/{companyPosId}

{
  "data": {
    "settings": {
      "isCheckInMenuEnabled": true,
      "isTransactionsEnabled": true,
      "isPosRulesEnabled": true,
      "isReceiptPromotionEnabled": true,
      "isCouponsEnabled": true,
      "isProductsImportEnabled": true
    }
  }
}

Headers

Name	Value	Description
Authorization	Bearer access_token	Request authorization header
Content-Type	application/json	Content type

Path Parameters

Field name	Type	Description
posSystem	string	The identifier of the POS system (e.g., pax, clover)
companyPosId	string	The company POS identifier

Response Fields

object

POS system configuration settings

Show Settings Properties

object

Feature flags for the POS system

Show Feature Flags

Indicates if check-in menu is enabled

boolean

Indicates if transactions are enabled

boolean

Indicates if POS rules are enabled

boolean

Indicates if receipt promotion is enabled

boolean

Indicates if coupons are enabled

boolean

Indicates if products import is enabled

If isTransactionsEnabled is false, the POS system should not send any transactions to ClearLine.

Start a New Interaction

Start a new session between the POS system and the marketing platform. This creates a session identifier that will be used to track the transaction flow.

POST https://public-api-test.clearline.me/pos/{posSystem}/startInteraction

{
  "posLocationId": "{posLocationId}",
  "terminalId": "{terminalId}"
}

{
  "data": {
    "sessionId": "f7892b12-e01a-4717-a306-fce8af792b9c",
    "posStatus": "Accepted"
  }
}

Headers

Name	Value	Description
Authorization	Bearer access_token	Request authorization header
Content-Type	application/json	Content type

Path Parameters

Field name	Type	Description
posSystem	string	The identifier of the POS system (e.g., pax, clover)

Request Body

Field name	Type	Required	Description
posLocationId	string	Yes	The identifier of the POS location
terminalId	string	Yes	The identifier of the POS terminal

Response Fields

object

Session initialization data

Show Properties

string

Unique identifier of the session to be used in subsequent API calls

string

POS status indicating the result: Accepted, Disabled, or NotAvailable

Send Transaction Details

Send a completed POS transaction to the marketing platform. This action may trigger the execution of a widget session automatically based on configured POS rules.

POST https://public-api-test.clearline.me/pos/{posSystem}/transaction

{
  "posLocationId": "{posLocationId}",
  "transactionId": "{transactionId}",
  "transactionType": "Sale",
  "transactionAmount": "19",
  "transactionDate": "2025-07-25T19:51:30.113",
  "terminalID": "{terminalID}",
  "sessionId": "{sessionId}",
  "customer": {
    "id": "",
    "firstName": "test210525p",
    "lastName": "test210525p",
    "birthDate": "1985-05-21T00:00:00",
    "contacts": [
      {
        "email": "test210525p@mail.com",
        "phone": "11111111111"
      }
    ]
  },
  "products": [
    {
      "productId": "10285",
      "productName": "Milk",
      "manufacturer": "Best",
      "productCategory": "Food",
      "quantity": 1
    }
  ],
  "loyalty": {
    "cardNumber": null
  }
}

{
  "data": {
    "id": "6886834645735100017eac4b",
    "qrCodeWidget": {
      "shortLinkUrl": "https://shorttest.clearline.me/RE-klOWT?sessionId=f7232bcc-e01a-4717-a306-fce8af792b9c&cashRegisterId=962",
      "qrCode": {
        "htmlLinkUrl": "https://webtest.clearline.me:443/qrcode/Html?..",
        "previewHtmlLinkUrl": "https://webtest.clearline.me:443/qrcode/Html?.."
      },
      "notificationMessageId": null,
      "profile": {
        "id": "6787d9bf6430560001023385",
        "firstName": "test210525p",
        "lastName": "test210525p",
        "customerEmail": "test210525p@mail.com",
        "customerPhone": "+11111111111",
        "salesPerson": null,
        "purchaseName": null,
        "purchaseId": null,
        "purchaseCategory": null,
        "purchasePrice": null,
        "gender": "False"
      },
      "sessionId": "f7232bcc-e01a-4717-a306-fce8af792b9c"
    },
    "cfsTemplate": {
      "accountTemplateId": 0,
      "cfsCarouselUrl": null
    },
    "posStatus": "Accepted",
    "loyalty": {
      "status": "NotFound",
      "awardDescription": null,
      "qrCode": {
        "linkUrl": "https://shorttest.clearline.me/RT-aTqH0",
        "qrCodeLinkUrl": "https://webtest.clearline.me:443/qrcode/Png..",
        "primaryText": "Join Our Loyalty Program! <br>  Scan the QR Code to register for the Loyalty Program!",
        "secondaryText": "SCAN ME"
      }
    }
  }
}

Headers

Name	Value	Description
Authorization	Bearer access_token	Request authorization header
Content-Type	application/json	Content type

Path Parameters

Field name	Type	Description
posSystem	string	The identifier of the POS system (e.g., pax, clover)

Request Body

Field name	Type	Required	Description
posLocationId	string	Yes	The identifier of the POS location
transactionId	string	Yes	Unique transaction identifier
transactionType	string	Yes	Type of transaction (e.g., “Sale”)
transactionAmount	string	Yes	Total transaction amount
transactionDate	string	Yes	Transaction date and time in ISO 8601 format
terminalID	string	Yes	The identifier of the POS terminal
sessionId	string	Yes	Session ID from the startInteraction call
customer	object	No	Customer information
products	object[]	No	Array of products in the transaction
loyalty	object	No	Loyalty program information

Response Fields

object

Transaction processing result with triggered marketing actions

Show Properties

string

Transaction identifier in ClearLine system

QR code widget information if a widget was triggered

Show QR Code Widget Properties

string

Shortened URL for the widget

object

QR code URLs for display

object

Customer profile information

string

Session identifier for this widget interaction

object

Customer-facing screen template information

Show CFS Template Properties

integer

Template identifier

string

URL for the CFS carousel display

string

Transaction processing status: Accepted, Disabled, or NotAvailable

object

Loyalty program response

Show Loyalty Properties

string

Loyalty status (e.g., “NotFound”, “Active”)

string

Description of loyalty award if applicable

object

QR code for loyalty program enrollment or rewards

Validate Coupon by Transaction

Validate coupons associated with a specific POS transaction within a marketing campaign session. This endpoint confirms coupon usage and records it in the system.

POST https://public-api-test.clearline.me/pos/{posSystem}/coupon/validate/byTransaction

{
  "sessionId": "string",
  "campaignId": "string",
  "transactionId": "string",
  "couponUser": {
    "firstName": "string",
    "lastName": "string",
    "gender": "string",
    "phone": "string",
    "email": "string"
  }
}

{
  "posStatus": "Accepted",
  "data": {
    "externalSessionId": "{externalSessionId}",
    "status": "Accepted",
    "validationDate": "2025-07-23T20:02:40.049Z",
    "errorMessage": ""
  }
}

Headers

Name	Value	Description
Authorization	Bearer access_token	Request authorization header
Content-Type	application/json	Content type

Path Parameters

Field name	Type	Description
posSystem	string	The identifier of the POS system (e.g., pax, clover)

Request Body

Field name	Type	Required	Description
sessionId	string	Yes	Session identifier from startInteraction call
campaignId	string	Yes	Marketing campaign identifier
transactionId	string	Yes	POS transaction identifier
couponUser	object	Yes	Information about the customer using the coupon

Coupon User Object

Field name	Type	Required	Description
firstName	string	No	Customer’s first name
lastName	string	No	Customer’s last name
gender	string	No	Customer’s gender
phone	string	No	Customer’s phone number
email	string	No	Customer’s email address

Response Fields

string

Overall POS status: Accepted, Disabled, or NotAvailable

object

Coupon validation result

Show Properties

string

External session identifier for tracking

string

Validation status: Accepted or error status

string

Date and time when the coupon was validated (ISO 8601 format)

string

Error message if validation failed, empty string if successful

Next Steps

Manual Flow

Implement manual widget selection flow

Checkout Integration Flow

View complete integration workflow

Transaction API

Explore transaction endpoints

Coupon API

Learn about coupon validation

Getting Started

Integration Options

POS Integration

API Reference

Overview

Check POS Settings

Headers

Path Parameters

Response Fields

Start a New Interaction

Headers

Path Parameters

Request Body

Response Fields

Send Transaction Details

Headers

Path Parameters

Request Body

Response Fields

Validate Coupon by Transaction

Headers

Path Parameters

Request Body

Coupon User Object

Response Fields

Next Steps

Manual Flow

Checkout Integration Flow

Transaction API

Coupon API

​Overview

​Check POS Settings

​Headers

​Path Parameters

​Response Fields

​Start a New Interaction

​Headers

​Path Parameters

​Request Body

​Response Fields

​Send Transaction Details

​Headers

​Path Parameters

​Request Body

​Response Fields

​Validate Coupon by Transaction

​Headers

​Path Parameters

​Request Body

​Coupon User Object

​Response Fields

​Next Steps

Manual Flow

Checkout Integration Flow

Transaction API

Coupon API

Overview

Check POS Settings

Headers

Path Parameters

Response Fields

Start a New Interaction

Headers

Path Parameters

Request Body

Response Fields

Send Transaction Details

Headers

Path Parameters

Request Body

Response Fields

Validate Coupon by Transaction

Headers

Path Parameters

Request Body

Coupon User Object

Response Fields

Next Steps