Skip to main content
POST
/
v2
/
pos
/
{posSystemId}
/
coupon
/
lookup
Lookup coupons, by keyword
curl --request POST \
  --url https://public-api-demo.clearline.me/v2/pos/{posSystemId}/coupon/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "posLocationId": "6orMqUyq2Hg3tP",
  "keyword": ""
}
'
{
  "data": {
    "coupons": [
      {
        "id": "<string>",
        "couponImage": "<string>",
        "name": "<string>",
        "title": "<string>",
        "subtitle": "<string>",
        "description": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

posSystemId
string
required

POS system identifier

Body

Request

Request model for looking up coupons

posLocationId
string
required

The POS location identifier

Minimum string length: 1
keyword
string | null

Search key word for filtering coupons

Response

Success

data
object

Response model for looking up coupons