POST api/marketing/MarketlistTemplateParametersAction
Получение данных (параметров/критериев), с которыми был создан маркетинговый список клиентов
Request Information
URI Parameters
None.
Body Parameters
MarketlistTemplateParametersActionRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| MarketListSaveData |
Идентификатор записи хранения данных (параметров) маркетингового списка |
integer |
None. |
| ActionType |
Тип действия (info) |
string |
None. |
| MarketList |
Идентификатор маркетингового списка клиентов, данные которого сохраняли при создании |
integer |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"MarketListSaveData": 1,
"ActionType": "sample string 1",
"MarketList": 1,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 2"
}
application/xml, text/xml
<MarketlistTemplateParametersActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MarketingRequest"> <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 2</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 1</ActionType> <MarketList>1</MarketList> <MarketListSaveData>1</MarketListSaveData> </MarketlistTemplateParametersActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
MarketlistTemplateParametersActionResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Наименование создаваемого маркетингового списка |
string |
None. |
| Template |
Идентификатор шаблона, по которому нужно создать выборку |
integer |
None. |
| ForSms |
Признак, что выборка создаётся для отправки коммуникации по каналу sms |
boolean |
None. |
| ForPush |
Признак, что выборка создаётся для отправки коммуникации по каналу push |
boolean |
None. |
| ForEmail |
Признак, что выборка создаётся для отправки коммуникации по каналу email |
boolean |
None. |
| ForTelegram |
Признак, что выборка создаётся для отправки коммуникации по каналу telegram |
boolean |
None. |
| ForNoCommunication |
Признак, что выборка делается (или список создаётся) не для отправки коммуникации |
boolean |
None. |
| TelegramBotId |
Идентификатор бота в телеграм, подписчики которого должны попасть в выборку |
integer |
None. |
| TelegramChannelId |
Идентификатор канала в телеграм, подписчики которого должны попасть в выборку |
integer |
None. |
| PurchaseBegDate |
Дата начала анализа периода активности клиента |
date |
None. |
| PurchaseEndDate |
Дата окончания анализа периода активности клиента |
date |
None. |
| MinPurchaseCountPeriod |
Минимальное количество покупок, которое было совершено за период |
integer |
None. |
| MaxPurchaseCountPeriod |
Максимальное количество покупок, которое было совершено за период |
integer |
None. |
| MinGainPeriod |
Минимальная выручка за период |
decimal number |
None. |
| MaxGainPeriod |
Максимальная выручка за период |
decimal number |
None. |
| MonthNoPurchaseAgo |
Количество месяцев назад от сегодня, в которых НЕ было ни одной покупки |
integer |
None. |
| MonthPurchaseAgo |
Количество месяцев назад от сегодня, в которых была хотя бы одна покупка у клиента |
integer |
None. |
| NoPurchaseBegDate |
Дата начала анализа периода НЕ активности клиента (начальный период даты последней покупки клиента) |
date |
None. |
| NoPurchaseEndDate |
Дата окончания периода анализа НЕ активности клиента (конечный период даты последней покупки клиента) |
date |
None. |
| PurchasePos |
Точка, в которой была совершена покупка, за период |
integer |
None. |
| PurchasePartner |
Партнер, в точках которого была совершена покупка, за период |
integer |
None. |
| PurchasePosList |
Список точек, в одной из которых была совершена покупка, за период |
integer |
None. |
| PurchaseCity |
Город, в точках которого была совершена покупка, за период |
integer |
None. |
| CounterMinGain |
Минимальная выручка за всё время |
decimal number |
None. |
| CounterMaxGain |
Максимальная выручка за всё время |
decimal number |
None. |
| CounterPurchases |
Строгое количество покупок за всё время |
decimal number |
None. |
| CounterMinPurchases |
Минимальное количество покупок за всё время |
decimal number |
None. |
| CounterMaxPurchases |
Максимальное количество покупок за всё время |
decimal number |
None. |
| CounterRedeemCount |
Строгое количество операций списания бонусов за всё время |
decimal number |
None. |
| CounterMinRedeemSum |
Минимальная сумма списания бонусов за всё время |
decimal number |
None. |
| CardLevel |
В маркетинговый список попадают только карты уровня с этим идентификатором |
integer |
None. |
| MinCardBalance |
Минимальный баланс бонусов карты клиента |
decimal number |
None. |
| MaxCardBalance |
Максимальный баланс бонусов карты клиента |
decimal number |
None. |
| Gender |
Пол клиента (1 = мужчины, 0 = женщины) |
boolean |
None. |
| MinAges |
Минимальный возраст клиента |
byte |
None. |
| MaxAges |
Максимальный возраст клиента |
byte |
None. |
| CardType |
Идентификатор типа карты клиента |
integer |
None. |
| CardTypeList |
Идентификатор списка карт клиентов |
integer |
None. |
| NoCardType |
Исключающий фильтр: НЕ тип карты клиентов |
integer |
None. |
| NoCardTypeList |
Исключающий фильтр: НЕ список карт клиентов |
integer |
None. |
| AverageSum |
Сравнительная сумма для выборки по среднему чеку |
decimal number |
None. |
| AverageMore |
Признак больше (true) или меньше (false) сравнительной суммы среднего чека |
boolean |
None. |
| PurchaseCode |
Код товара, который приобретался за период |
string |
None. |
| PurchaseItemList |
Идентификатор списка кодов товаров, товары в котором (хотя бы один) хотя бы один раз, за период |
integer |
None. |
| PurchaseGoodList |
Идентификатор списка товаров, товары в котором (хотя бы один) хотя бы один раз приобретались, за период |
integer |
None. |
| CatalogPositionId |
Идентификатор позиции каталога, товары которого приобретались, за период |
integer |
None. |
| NoCatalogPositionId |
Идентификатор позиции каталога, товары которого не приобретались, за период |
integer |
None. |
| RegPos |
Идентификатор точки, в которой зарегистрировался клиент |
integer |
None. |
| RegBegDate |
Дата начала периода регистрации клиента |
date |
None. |
| RegEndDate |
Дата окончания периода регистрации клиента |
date |
None. |
| DaysRegDateAgo |
Количество дней регистрации клиента от сегодня |
integer |
None. |
| LimitClients |
Максимальное количество клиентов, которые должны попасть в выборку |
integer |
None. |
| FirstPurchasePartner |
Партнёр, в точках которого была совершена первая покупка |
integer |
None. |
| LastPurchaseDateBegDate |
Дата начала периода анализа даты последней покупки клиента |
date |
None. |
| LastPurchaseDateEndDate |
Дата окончания периода анализа даты последней покупки клиента |
date |
None. |
| RegPartner |
Партнер, в точках которого был зарегистрирован клиент |
integer |
None. |
| RegPosList |
Список точек, в которых был зарегистрирован клиент |
integer |
None. |
| NoRegPosList |
Список точек, в которых НЕ был зарегистрирован клиент |
integer |
None. |
| RegCity |
Город, в точках которого был зарегистрирован клиент |
integer |
None. |
| NoRegCity |
Город, в точках которого НЕ был зарегистрирован клиент |
integer |
None. |
| BirthBegDate |
Начало периода дней рождения |
date |
None. |
| BirthEndDate |
Окончание периода дней рождения |
date |
None. |
| PurchasePosName |
Наименование точки, в которой была совершена покупка, за период |
string |
None. |
| PurchasePartnerName |
Наименование партнера, в точках которого была совершена покупка, за период |
string |
None. |
| PurchasePosListName |
Наименование списка точек, в одной из которых была совершена покупка, за период |
string |
None. |
| PurchaseCityName |
Наименование города, в точках которого была совершена покупка, за период |
string |
None. |
| CardLevelName |
Наименование уровня карт |
string |
None. |
| CardTypeName |
Наименование типа карты клиента |
string |
None. |
| CardTypeListName |
Наименование списка типов карт клиента |
string |
None. |
| NoCardTypeName |
Наименование НЕ типа карты клиента |
string |
None. |
| NoCardTypeListName |
Наименование НЕ списка типов карт клиента |
string |
None. |
| FirstPurchasePartnerName |
Наименование партнёра, в точках которого была совершена первая покупка |
string |
None. |
| RegPartnerName |
Наименование партнёра, в точках которого был зарегистрирован клиент |
string |
None. |
| RegCityName |
Наименование города, в точках которого был зарегистрирован клиент |
string |
None. |
| NoRegCityName |
Наименование города, в точках которого НЕ был зарегистрирован клиент |
string |
None. |
| RegPosName |
Наименование точки, в которой зарегистрировался клиент |
string |
None. |
| RegPosListName |
Наименование списка точек, в которых был зарегистрирован клиент |
string |
None. |
| NoRegPosListName |
Наименование списка точек, в которых НЕ был зарегистрирован клиент |
string |
None. |
| Data |
Данные "листов", заданные при создании списков |
Collection of MarketlistTemplateParametersActionDataRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"Name": "sample string 1",
"Template": 1,
"ForSms": true,
"ForPush": true,
"ForEmail": true,
"ForTelegram": true,
"ForNoCommunication": true,
"TelegramBotId": 1,
"TelegramChannelId": 1,
"PurchaseBegDate": "2025-12-22T09:27:55.6074078+03:00",
"PurchaseEndDate": "2025-12-22T09:27:55.6074078+03:00",
"MinPurchaseCountPeriod": 1,
"MaxPurchaseCountPeriod": 1,
"MinGainPeriod": 1.0,
"MaxGainPeriod": 1.0,
"MonthNoPurchaseAgo": 1,
"MonthPurchaseAgo": 1,
"NoPurchaseBegDate": "2025-12-22T09:27:55.6074078+03:00",
"NoPurchaseEndDate": "2025-12-22T09:27:55.6074078+03:00",
"PurchasePos": 1,
"PurchasePartner": 1,
"PurchasePosList": 1,
"PurchaseCity": 1,
"CounterMinGain": 1.0,
"CounterMaxGain": 1.0,
"CounterPurchases": 1.0,
"CounterMinPurchases": 1.0,
"CounterMaxPurchases": 1.0,
"CounterRedeemCount": 1.0,
"CounterMinRedeemSum": 1.0,
"CardLevel": 1,
"MinCardBalance": 1.0,
"MaxCardBalance": 1.0,
"Gender": true,
"MinAges": 64,
"MaxAges": 64,
"CardType": 1,
"CardTypeList": 1,
"NoCardType": 1,
"NoCardTypeList": 1,
"AverageSum": 1.0,
"AverageMore": true,
"PurchaseCode": "sample string 2",
"PurchaseItemList": 1,
"PurchaseGoodList": 1,
"CatalogPositionId": 1,
"NoCatalogPositionId": 1,
"RegPos": 1,
"RegBegDate": "2025-12-22T09:27:55.6074078+03:00",
"RegEndDate": "2025-12-22T09:27:55.6074078+03:00",
"DaysRegDateAgo": 1,
"LimitClients": 1,
"FirstPurchasePartner": 1,
"LastPurchaseDateBegDate": "2025-12-22T09:27:55.6074078+03:00",
"LastPurchaseDateEndDate": "2025-12-22T09:27:55.6074078+03:00",
"RegPartner": 1,
"RegPosList": 1,
"NoRegPosList": 1,
"RegCity": 1,
"NoRegCity": 1,
"BirthBegDate": "2025-12-22T09:27:55.6074078+03:00",
"BirthEndDate": "2025-12-22T09:27:55.6074078+03:00",
"PurchasePosName": "sample string 3",
"PurchasePartnerName": "sample string 4",
"PurchasePosListName": "sample string 5",
"PurchaseCityName": "sample string 6",
"CardLevelName": "sample string 7",
"CardTypeName": "sample string 8",
"CardTypeListName": "sample string 9",
"NoCardTypeName": "sample string 10",
"NoCardTypeListName": "sample string 11",
"FirstPurchasePartnerName": "sample string 12",
"RegPartnerName": "sample string 13",
"RegCityName": "sample string 14",
"NoRegCityName": "sample string 15",
"RegPosName": "sample string 16",
"RegPosListName": "sample string 17",
"NoRegPosListName": "sample string 18",
"Data": [
{
"Id": 1,
"SourceType": "sample string 1",
"SourceId": 1,
"Exclude": true,
"SourceTypeName": "sample string 2"
},
{
"Id": 1,
"SourceType": "sample string 1",
"SourceId": 1,
"Exclude": true,
"SourceTypeName": "sample string 2"
}
],
"ErrorCode": 19,
"Message": "sample string 20"
}
application/xml, text/xml
<MarketlistTemplateParametersActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MarketingResponse">
<ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">19</ErrorCode>
<Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 20</Message>
<AverageMore>true</AverageMore>
<AverageSum>1</AverageSum>
<BirthBegDate>2025-12-22T09:27:55.6074078+03:00</BirthBegDate>
<BirthEndDate>2025-12-22T09:27:55.6074078+03:00</BirthEndDate>
<CardLevel>1</CardLevel>
<CardLevelName>sample string 7</CardLevelName>
<CardType>1</CardType>
<CardTypeList>1</CardTypeList>
<CardTypeListName>sample string 9</CardTypeListName>
<CardTypeName>sample string 8</CardTypeName>
<CatalogPositionId>1</CatalogPositionId>
<CounterMaxGain>1</CounterMaxGain>
<CounterMaxPurchases>1</CounterMaxPurchases>
<CounterMinGain>1</CounterMinGain>
<CounterMinPurchases>1</CounterMinPurchases>
<CounterMinRedeemSum>1</CounterMinRedeemSum>
<CounterPurchases>1</CounterPurchases>
<CounterRedeemCount>1</CounterRedeemCount>
<Data>
<MarketlistTemplateParametersActionResponse.MarketlistTemplateParametersActionDataRow>
<Exclude>true</Exclude>
<Id>1</Id>
<SourceId>1</SourceId>
<SourceType>sample string 1</SourceType>
<SourceTypeName>sample string 2</SourceTypeName>
</MarketlistTemplateParametersActionResponse.MarketlistTemplateParametersActionDataRow>
<MarketlistTemplateParametersActionResponse.MarketlistTemplateParametersActionDataRow>
<Exclude>true</Exclude>
<Id>1</Id>
<SourceId>1</SourceId>
<SourceType>sample string 1</SourceType>
<SourceTypeName>sample string 2</SourceTypeName>
</MarketlistTemplateParametersActionResponse.MarketlistTemplateParametersActionDataRow>
</Data>
<DaysRegDateAgo>1</DaysRegDateAgo>
<FirstPurchasePartner>1</FirstPurchasePartner>
<FirstPurchasePartnerName>sample string 12</FirstPurchasePartnerName>
<ForEmail>true</ForEmail>
<ForNoCommunication>true</ForNoCommunication>
<ForPush>true</ForPush>
<ForSms>true</ForSms>
<ForTelegram>true</ForTelegram>
<Gender>true</Gender>
<LastPurchaseDateBegDate>2025-12-22T09:27:55.6074078+03:00</LastPurchaseDateBegDate>
<LastPurchaseDateEndDate>2025-12-22T09:27:55.6074078+03:00</LastPurchaseDateEndDate>
<LimitClients>1</LimitClients>
<MaxAges>64</MaxAges>
<MaxCardBalance>1</MaxCardBalance>
<MaxGainPeriod>1</MaxGainPeriod>
<MaxPurchaseCountPeriod>1</MaxPurchaseCountPeriod>
<MinAges>64</MinAges>
<MinCardBalance>1</MinCardBalance>
<MinGainPeriod>1</MinGainPeriod>
<MinPurchaseCountPeriod>1</MinPurchaseCountPeriod>
<MonthNoPurchaseAgo>1</MonthNoPurchaseAgo>
<MonthPurchaseAgo>1</MonthPurchaseAgo>
<Name>sample string 1</Name>
<NoCardType>1</NoCardType>
<NoCardTypeList>1</NoCardTypeList>
<NoCardTypeListName>sample string 11</NoCardTypeListName>
<NoCardTypeName>sample string 10</NoCardTypeName>
<NoCatalogPositionId>1</NoCatalogPositionId>
<NoPurchaseBegDate>2025-12-22T09:27:55.6074078+03:00</NoPurchaseBegDate>
<NoPurchaseEndDate>2025-12-22T09:27:55.6074078+03:00</NoPurchaseEndDate>
<NoRegCity>1</NoRegCity>
<NoRegCityName>sample string 15</NoRegCityName>
<NoRegPosList>1</NoRegPosList>
<NoRegPosListName>sample string 18</NoRegPosListName>
<PurchaseBegDate>2025-12-22T09:27:55.6074078+03:00</PurchaseBegDate>
<PurchaseCity>1</PurchaseCity>
<PurchaseCityName>sample string 6</PurchaseCityName>
<PurchaseCode>sample string 2</PurchaseCode>
<PurchaseEndDate>2025-12-22T09:27:55.6074078+03:00</PurchaseEndDate>
<PurchaseGoodList>1</PurchaseGoodList>
<PurchaseItemList>1</PurchaseItemList>
<PurchasePartner>1</PurchasePartner>
<PurchasePartnerName>sample string 4</PurchasePartnerName>
<PurchasePos>1</PurchasePos>
<PurchasePosList>1</PurchasePosList>
<PurchasePosListName>sample string 5</PurchasePosListName>
<PurchasePosName>sample string 3</PurchasePosName>
<RegBegDate>2025-12-22T09:27:55.6074078+03:00</RegBegDate>
<RegCity>1</RegCity>
<RegCityName>sample string 14</RegCityName>
<RegEndDate>2025-12-22T09:27:55.6074078+03:00</RegEndDate>
<RegPartner>1</RegPartner>
<RegPartnerName>sample string 13</RegPartnerName>
<RegPos>1</RegPos>
<RegPosList>1</RegPosList>
<RegPosListName>sample string 17</RegPosListName>
<RegPosName>sample string 16</RegPosName>
<TelegramBotId>1</TelegramBotId>
<TelegramChannelId>1</TelegramChannelId>
<Template>1</Template>
</MarketlistTemplateParametersActionResponse>