Skip to main content
GET
/
pos
/
{posSystemId}
/
coupon
/
active
/
locationId
/
{posLocationId}
Get active coupons
curl --request GET \
  --url https://public-api-demo.clearline.me/pos/{posSystemId}/coupon/active/locationId/{posLocationId} \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "code": "<string>",
      "url": "<string>",
      "couponImage": "<string>",
      "status": "example | active | archived | template | deleted",
      "name": "<string>",
      "title": "<string>",
      "subtitle": "<string>",
      "description": "<string>",
      "couponCategoryId": "<string>",
      "couponCategoryName": "<string>",
      "banner1": "<string>",
      "banner2": "<string>",
      "banner3": "<string>",
      "banner4": "<string>",
      "banner5": "<string>",
      "subaccount": "<string>",
      "logoUrl": "<string>",
      "couponTags": "<string>",
      "expiryDate": "<string>",
      "promotion": {
        "value": 123,
        "promotionType": 1
      },
      "isSelected": true
    }
  ],
  "page": {
    "page": 123,
    "pageSize": 123,
    "total": 123
  },
  "posStatus": "Accepted"
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Enter JWT Bearer token only in the text input below.

Path Parameters

posSystemId
string
required

Pos system name

posLocationId
string
required

Pos location identifier

Response

Success

data
object[] | null
page
object
posStatus
enum<string>
Available options:
Accepted,
Disabled,
NotAvailable