Skip to main content

​
Coupons Import

Imports one or more coupons into the system from an external POS System.

​
Coupons

POST https://apitest.clearline.me/v2/pos/{posSystemId}/import/coupons/company/{posCompanyId}

​
Input request

{
  "coupons": [
    {
      "name": "string",
      "title": "string",
      "subtitle": "string",
      "description": "string",
      "startDate": "2026-01-01T11:11:11.954Z",
      "promotion": {
        "promotionType": "Amount",
        "value": 0
      },
      "couponImage": "string"
    }
  ]
}

​
Input parameters

Field nameDescription
couponsCoupons block
nameCoupon name
titleCoupon title
substitleCoupon subtitle
descriptionCoupon description
startDateThe date and time when the coupon becomes active
promotionPromotion block
promotionTypePromotion type: Amount or Percentage
valuePromotion value: $10 or 5% discount
couponImageCoupon image

​
Response

{
  "data": {
    "importId": "string"
  }
}