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}
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 POS system configuration settings Feature flags for the POS system Indicates if check-in menu is enabled
Indicates if transactions are enabled
Indicates if POS rules are enabled
isReceiptPromotionEnabled
Indicates if receipt promotion is enabled
Indicates if coupons are enabled
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.
Request
Request Body
Response
POST https://public-api-test.clearline.me/pos/{posSystem}/startInteraction
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 Session initialization data Unique identifier of the session to be used in subsequent API calls
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.
Request
Request Body
Response
POST https://public-api-test.clearline.me/pos/{posSystem}/transaction
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 Transaction processing result with triggered marketing actions Transaction identifier in ClearLine system
QR code widget information if a widget was triggered Show QR Code Widget Properties
Shortened URL for the widget
Customer profile information
Session identifier for this widget interaction
Customer-facing screen template information Show CFS Template Properties
URL for the CFS carousel display
Transaction processing status: Accepted, Disabled, or NotAvailable
Loyalty program response Loyalty status (e.g., “NotFound”, “Active”)
Description of loyalty award if applicable
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.
Request
Request Body
Response
POST https://public-api-test.clearline.me/pos/{posSystem}/coupon/validate/byTransaction
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 Overall POS status: Accepted, Disabled, or NotAvailable
Coupon validation result External session identifier for tracking
Validation status: Accepted or error status
Date and time when the coupon was validated (ISO 8601 format)
Error message if validation failed, empty string if successful
Next Steps 
