POST api/coupon/SeriesAction

Создание/изменение/получение информации по серии купонов

Request Information

URI Parameters

None.

Body Parameters

CouponRequestSeriesAction
NameDescriptionTypeAdditional information
ActionType

Тип действия (Create, Update, Info)

 string

None.
Name

Наименование серии купонов

 string

None.
CouponSeriesId

Идентификатор серии для изменения или получения информации

 integer

None.
CouponForRedeem

Признак разрешения применение купонов серии при заданном списании по чеку

 boolean

None.
RedeemForCoupon

Признак разрешения списания бонусов если применён купон данной серии

 boolean

None.
AllowReuse

Можно ли переиспользовать купоны данной серии после первого применения

 boolean

None.
CouponType

Тип купона

 byte

None.
NoActive

Признак неактивности серии купонов

 boolean

None.
Campaign

Идентификатор акции, в рамках которой выпущен и существует купон

 integer

None.
Operator

Идентификатор оператора программы лояльности

 integer

None.
Token

Токен пользователя, который инициирует данный запрос

 integer

None.
SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ActionType": "sample string 1",
  "Name": "sample string 2",
  "CouponSeriesId": 1,
  "CouponForRedeem": true,
  "RedeemForCoupon": true,
  "AllowReuse": true,
  "CouponType": 64,
  "NoActive": true,
  "Campaign": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample: 
<SeriesActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.CouponRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 1</ActionType>
  <AllowReuse>true</AllowReuse>
  <Campaign>1</Campaign>
  <CouponForRedeem>true</CouponForRedeem>
  <CouponSeriesId>1</CouponSeriesId>
  <CouponType>64</CouponType>
  <Name>sample string 2</Name>
  <NoActive>true</NoActive>
  <RedeemForCoupon>true</RedeemForCoupon>
</SeriesActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CouponResponseSeriesAction
NameDescriptionTypeAdditional information
CouponSeries

Идентификатор серии в рамках которой выпущен купон

 integer

None.
Data

Массив данных

 Collection of CouponSeriesDataRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

Сообщение об ошибке

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CouponSeries": 1,
  "Data": [
    {
      "Id": 1,
      "CouponSeriesId": 1,
      "CouponSeriesName": "sample string 1",
      "Campaign": 1,
      "CouponType": 64,
      "CouponTypeName": "sample string 2",
      "CouponForRedeem": true,
      "RedeemForCoupon": true,
      "AllowReuse": true,
      "NoActive": true,
      "DateCreate": "2025-12-22T09:28:30.5001794+03:00",
      "CountCoupons": 1
    },
    {
      "Id": 1,
      "CouponSeriesId": 1,
      "CouponSeriesName": "sample string 1",
      "Campaign": 1,
      "CouponType": 64,
      "CouponTypeName": "sample string 2",
      "CouponForRedeem": true,
      "RedeemForCoupon": true,
      "AllowReuse": true,
      "NoActive": true,
      "DateCreate": "2025-12-22T09:28:30.5001794+03:00",
      "CountCoupons": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<SeriesActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.CouponResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <CouponSeries>1</CouponSeries>
  <Data>
    <CouponSeriesDataRow>
      <AllowReuse>true</AllowReuse>
      <Campaign>1</Campaign>
      <CountCoupons>1</CountCoupons>
      <CouponForRedeem>true</CouponForRedeem>
      <CouponSeriesId>1</CouponSeriesId>
      <CouponSeriesName>sample string 1</CouponSeriesName>
      <CouponType>64</CouponType>
      <CouponTypeName>sample string 2</CouponTypeName>
      <DateCreate>2025-12-22T09:28:30.5001794+03:00</DateCreate>
      <Id>1</Id>
      <NoActive>true</NoActive>
      <RedeemForCoupon>true</RedeemForCoupon>
    </CouponSeriesDataRow>
    <CouponSeriesDataRow>
      <AllowReuse>true</AllowReuse>
      <Campaign>1</Campaign>
      <CountCoupons>1</CountCoupons>
      <CouponForRedeem>true</CouponForRedeem>
      <CouponSeriesId>1</CouponSeriesId>
      <CouponSeriesName>sample string 1</CouponSeriesName>
      <CouponType>64</CouponType>
      <CouponTypeName>sample string 2</CouponTypeName>
      <DateCreate>2025-12-22T09:28:30.5001794+03:00</DateCreate>
      <Id>1</Id>
      <NoActive>true</NoActive>
      <RedeemForCoupon>true</RedeemForCoupon>
    </CouponSeriesDataRow>
  </Data>
</SeriesActionResponse>