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 name	Description
coupons	Coupons block
externalCouponId	The external identifier of the coupon
name	Coupon name
code	Coupon code
title	Coupon title
subtitle	Coupon subtitle
description	Coupon description
startDate	The date and time when the coupon becomes active
promotion	Promotion block
promotionType	Promotion type: Amount or Percentage
value	Promotion value: $10 or 5% discount
couponImage	Coupon image (optional)
couponCodes	Coupon codes block
code	Coupon 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"
  }
}