POST api/marketing/MarketlistTemplate

Получение данных о количестве клиентов, которые соответствуют заданным фильтрам или создание маркетингового списка клиентов

Request Information

URI Parameters

None.

Body Parameters

MarketListTemplateRequest

Name	Description	Type	Additional information
PosCode	Код торговой точки	string	None.
Name	Наименование создаваемого маркетингового списка	string	None.
Create	Только при значении параметра 1 маркетинговый список будет создан, иначе только вернется количество карт, попадающих в критерии	boolean	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.
CounterRedeemCount	Строгое количество операций списания бонусов за всё время	decimal number	None.
CounterMinRedeemsum	Минимальная сумма списания бонусов за всё время	decimal number	None.
InList	Перечень маркетинговых списков, клиенты которых должны попасть в выборку	Collection of MarketListTemplateListRow	None.
NotInList	Исключающий фильтр: перечень маркетинговых списков, клиенты которых НЕ должны попасть в выборку	Collection of MarketListTemplateListRow	None.
CardPhoneClientList	Список карт/телефонов/клиентов для создания маркетингового списка	Collection of MarketListTemplateCardPhoneClientListRow	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.
RegCity	Город, в точках которого был зарегистрирован клиент	integer	None.
InRuleList	Список правил, которые срабатывали на клиенте	Collection of MarketingRuleListRow	None.
NoInRuleList	Список правил, которые НЕ срабатывали на клиенте	Collection of MarketingRuleListRow	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PosCode": "sample string 1",
  "Name": "sample string 2",
  "Create": true,
  "Template": 1,
  "ForSms": true,
  "ForPush": true,
  "ForEmail": true,
  "ForTelegram": true,
  "ForNoCommunication": true,
  "TelegramBotId": 1,
  "TelegramChannelId": 1,
  "PurchaseBegDate": "2024-04-29T15:30:05.5993832+03:00",
  "PurchaseEndDate": "2024-04-29T15:30:05.5993832+03:00",
  "MinPurchaseCountPeriod": 1,
  "MaxPurchaseCountPeriod": 1,
  "MinGainPeriod": 1.0,
  "MaxGainPeriod": 1.0,
  "MonthNoPurchaseAgo": 1,
  "MonthPurchaseAgo": 1,
  "NoPurchaseBegDate": "2024-04-29T15:30:05.5993832+03:00",
  "NoPurchaseEndDate": "2024-04-29T15:30:05.5993832+03:00",
  "PurchasePos": 1,
  "PurchasePartner": 1,
  "PurchasePosList": 1,
  "PurchaseCity": 1,
  "CounterMinGain": 1.0,
  "CounterMaxGain": 1.0,
  "CounterPurchases": 1.0,
  "CounterMinPurchases": 1.0,
  "CounterRedeemCount": 1.0,
  "CounterMinRedeemsum": 1.0,
  "InList": [
    {
      "Id": 1,
      "MarketList": 1
    },
    {
      "Id": 1,
      "MarketList": 1
    }
  ],
  "NotInList": [
    {
      "Id": 1,
      "MarketList": 1
    },
    {
      "Id": 1,
      "MarketList": 1
    }
  ],
  "CardPhoneClientList": [
    {
      "Id": 1,
      "Phone": 1,
      "Client": 1,
      "Card": 1,
      "Bonus": 1.0
    },
    {
      "Id": 1,
      "Phone": 1,
      "Client": 1,
      "Card": 1,
      "Bonus": 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 3",
  "PurchaseItemList": 1,
  "PurchaseGoodList": 1,
  "CatalogPositionId": 1,
  "NoCatalogPositionId": 1,
  "RegPos": 1,
  "RegBegDate": "2024-04-29T15:30:05.6150064+03:00",
  "RegEndDate": "2024-04-29T15:30:05.6150064+03:00",
  "DaysRegDateAgo": 1,
  "LimitClients": 1,
  "FirstPurchasePartner": 1,
  "LastPurchaseDateBegDate": "2024-04-29T15:30:05.6150064+03:00",
  "LastPurchaseDateEndDate": "2024-04-29T15:30:05.6150064+03:00",
  "RegPartner": 1,
  "RegPosList": 1,
  "RegCity": 1,
  "InRuleList": [
    {
      "Id": 1,
      "ChequeRule": 1,
      "EventRule": 1,
      "BonusMarketList": 1
    },
    {
      "Id": 1,
      "ChequeRule": 1,
      "EventRule": 1,
      "BonusMarketList": 1
    }
  ],
  "NoInRuleList": [
    {
      "Id": 1,
      "ChequeRule": 1,
      "EventRule": 1,
      "BonusMarketList": 1
    },
    {
      "Id": 1,
      "ChequeRule": 1,
      "EventRule": 1,
      "BonusMarketList": 1
    }
  ],
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:

<MarketListTemplateRequest 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 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <AverageMore>true</AverageMore>
  <AverageSum>1</AverageSum>
  <CardLevel>1</CardLevel>
  <CardPhoneClientList>
    <MarketListTemplateRequest.MarketListTemplateCardPhoneClientListRow>
      <Bonus>1</Bonus>
      <Card>1</Card>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
    </MarketListTemplateRequest.MarketListTemplateCardPhoneClientListRow>
    <MarketListTemplateRequest.MarketListTemplateCardPhoneClientListRow>
      <Bonus>1</Bonus>
      <Card>1</Card>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
    </MarketListTemplateRequest.MarketListTemplateCardPhoneClientListRow>
  </CardPhoneClientList>
  <CardType>1</CardType>
  <CardTypeList>1</CardTypeList>
  <CatalogPositionId>1</CatalogPositionId>
  <CounterMaxGain>1</CounterMaxGain>
  <CounterMinGain>1</CounterMinGain>
  <CounterMinPurchases>1</CounterMinPurchases>
  <CounterMinRedeemsum>1</CounterMinRedeemsum>
  <CounterPurchases>1</CounterPurchases>
  <CounterRedeemCount>1</CounterRedeemCount>
  <Create>true</Create>
  <DaysRegDateAgo>1</DaysRegDateAgo>
  <FirstPurchasePartner>1</FirstPurchasePartner>
  <ForEmail>true</ForEmail>
  <ForNoCommunication>true</ForNoCommunication>
  <ForPush>true</ForPush>
  <ForSms>true</ForSms>
  <ForTelegram>true</ForTelegram>
  <Gender>true</Gender>
  <InList>
    <MarketListTemplateRequest.MarketListTemplateListRow>
      <Id>1</Id>
      <MarketList>1</MarketList>
    </MarketListTemplateRequest.MarketListTemplateListRow>
    <MarketListTemplateRequest.MarketListTemplateListRow>
      <Id>1</Id>
      <MarketList>1</MarketList>
    </MarketListTemplateRequest.MarketListTemplateListRow>
  </InList>
  <InRuleList>
    <MarketingRuleListRow>
      <BonusMarketList>1</BonusMarketList>
      <ChequeRule>1</ChequeRule>
      <EventRule>1</EventRule>
      <Id>1</Id>
    </MarketingRuleListRow>
    <MarketingRuleListRow>
      <BonusMarketList>1</BonusMarketList>
      <ChequeRule>1</ChequeRule>
      <EventRule>1</EventRule>
      <Id>1</Id>
    </MarketingRuleListRow>
  </InRuleList>
  <LastPurchaseDateBegDate>2024-04-29T15:30:05.6150064+03:00</LastPurchaseDateBegDate>
  <LastPurchaseDateEndDate>2024-04-29T15:30:05.6150064+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 2</Name>
  <NoCardType>1</NoCardType>
  <NoCardTypeList>1</NoCardTypeList>
  <NoCatalogPositionId>1</NoCatalogPositionId>
  <NoInRuleList>
    <MarketingRuleListRow>
      <BonusMarketList>1</BonusMarketList>
      <ChequeRule>1</ChequeRule>
      <EventRule>1</EventRule>
      <Id>1</Id>
    </MarketingRuleListRow>
    <MarketingRuleListRow>
      <BonusMarketList>1</BonusMarketList>
      <ChequeRule>1</ChequeRule>
      <EventRule>1</EventRule>
      <Id>1</Id>
    </MarketingRuleListRow>
  </NoInRuleList>
  <NoPurchaseBegDate>2024-04-29T15:30:05.5993832+03:00</NoPurchaseBegDate>
  <NoPurchaseEndDate>2024-04-29T15:30:05.5993832+03:00</NoPurchaseEndDate>
  <NotInList>
    <MarketListTemplateRequest.MarketListTemplateListRow>
      <Id>1</Id>
      <MarketList>1</MarketList>
    </MarketListTemplateRequest.MarketListTemplateListRow>
    <MarketListTemplateRequest.MarketListTemplateListRow>
      <Id>1</Id>
      <MarketList>1</MarketList>
    </MarketListTemplateRequest.MarketListTemplateListRow>
  </NotInList>
  <PosCode>sample string 1</PosCode>
  <PurchaseBegDate>2024-04-29T15:30:05.5993832+03:00</PurchaseBegDate>
  <PurchaseCity>1</PurchaseCity>
  <PurchaseCode>sample string 3</PurchaseCode>
  <PurchaseEndDate>2024-04-29T15:30:05.5993832+03:00</PurchaseEndDate>
  <PurchaseGoodList>1</PurchaseGoodList>
  <PurchaseItemList>1</PurchaseItemList>
  <PurchasePartner>1</PurchasePartner>
  <PurchasePos>1</PurchasePos>
  <PurchasePosList>1</PurchasePosList>
  <RegBegDate>2024-04-29T15:30:05.6150064+03:00</RegBegDate>
  <RegCity>1</RegCity>
  <RegEndDate>2024-04-29T15:30:05.6150064+03:00</RegEndDate>
  <RegPartner>1</RegPartner>
  <RegPos>1</RegPos>
  <RegPosList>1</RegPosList>
  <TelegramBotId>1</TelegramBotId>
  <TelegramChannelId>1</TelegramChannelId>
  <Template>1</Template>
</MarketListTemplateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MarketListTemplateResponse

Name	Description	Type	Additional information
MarketList	Идентификатор созданного маркетингового списка клиентов	integer	None.
Count	Общее количество клиентов в выборке (для create = false) или созданном списке (для create = true)	integer	None.
AllowCountCommunication	Количество клиентов в выборке (для create = false) или созданном списке (для create = true), которым можно отправить коммуникацию по указанному каналу коммуникации	integer	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "MarketList": 1,
  "Count": 1,
  "AllowCountCommunication": 1,
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<MarketListTemplateResponse 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">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <AllowCountCommunication>1</AllowCountCommunication>
  <Count>1</Count>
  <MarketList>1</MarketList>
</MarketListTemplateResponse>