Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clearline.me/llms.txt

Use this file to discover all available pages before exploring further.

​
Coupons Import

Imports one or more coupons into the system from an external POS System. POST https://apitest.clearline.me/v2/pos/{posSystemId}/import/coupons/company/{posCompanyId}

​
Input request

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

​
Input parameters

Field nameDescription
couponsCoupons block
externalCouponIdThe external identifier of the coupon
nameCoupon name
codeCoupon code
titleCoupon title
subtitleCoupon 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 (optional)
couponCodesCoupon codes block
codeCoupon code

​
Response

{
  "data": {
    "importedCount": 2,
    "failedItems": [
      {
        "externalCouponId": "string",
        "name": "string",
        "code": "string",
        "title": "string",
        "subtitle": "string",
        "description": "string",
        "startDate": "2026-01-01T11:11:11.954Z",
        "promotion": {
          "promotionType": Amount,
          "value": 0
        },
        "couponImage": "string",
        "couponCodes": [
          {
            "code": "string"
          }
        ]
      }
    ],
    "errorMessage": "string"
  }
}