Skip to main content
Coupon endpoints allow you to search for customer coupons, validate coupon codes, and apply discounts at the point of sale. This enables you to integrate ClearLine’s coupon system directly into your checkout flow.

​
What are Coupons?

Coupons are digital or physical discount codes that customers can redeem during purchase. Using these endpoints, you can:
  • Search Coupons: Find available coupons for a customer by phone, email, or loyalty card
  • Validate Codes: Check if a coupon code is valid and eligible for use
  • Apply Discounts: Calculate and apply coupon discounts to transactions
  • Track Usage: Monitor which coupons are redeemed and by whom

​
How It Works

Customer Provides Coupon

Customer enters a coupon code or is identified by phone/email/loyalty card at checkout.

Look Up or Validate Coupon

Use lookup endpoints to find customer’s available coupons or validate a specific code.

Apply Discount

Calculate discount amount based on coupon rules and apply to the transaction total.

Complete Transaction

Send the transaction with coupon details to mark it as redeemed.

​
Coupon Endpoints

Lookup & Validate Coupon Codes

Find and validate customer coupons (V2)

Lookup Coupon Codes

Search for available coupon codes (V2)

Lookup Coupons

Get coupons for a customer or location (V2)

Search User Coupons

Search coupons by customer parameters (V1)

Get Active Coupons by Location

List all active coupons for a location (V1)

Validate Coupon by Transaction

Validate coupon against transaction details (V1)

​
Best Practices

Validate Before Applying

Always validate coupons before applying discounts. Check expiration dates, usage limits, minimum purchase amounts, and product restrictions.
When a customer identifies themselves (loyalty card, phone), automatically look up and display their available coupons to encourage usage.
Support applying multiple coupons when allowed. Validate each coupon individually and check for conflicts or stacking restrictions.
Show customers the exact discount amount before completing the transaction. Make it clear how much they’re saving.
Include coupon information in the transaction endpoint call to mark coupons as redeemed and prevent double usage.

​
Coupon Types

ClearLine supports various coupon structures:
  • Percentage Off: Discount percentage (e.g., 20% off)
  • Fixed Amount: Specific dollar discount (e.g., $5 off)
  • BOGO: Buy one get one free or discounted
  • Free Item: Specific product at no charge
  • Minimum Purchase: Discounts requiring minimum spend
  • Product-Specific: Valid only for certain items or categories
The endpoint responses include coupon type and discount rules for proper application.

​
Next Steps

Coupon API Reference

View complete API specification (V2)

Coupon Integration Guide

Step-by-step implementation guide with examples

Validate Coupons via Transaction

Learn how to validate coupons during checkout

Sync Coupons to POS

Keep your POS system in sync with ClearLine coupons