POST api/marketing/MarketlistPurchases

Данные о покупках клиентов за период, по маркетинговому списку, в привязке к рассылкам и правилам, с детализацией и без

Request Information

URI Parameters

None.

Body Parameters

MarketlistPurchasesRequest
NameDescriptionTypeAdditional information
MarketList

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

integer

None.

Detail

признак, что нужно вернуть детализацию по картам (для отчёта)

boolean

None.

BegDate

Дата начала периода анализа

date

None.

EndDate

Дата окончания периода анализа

date

None.

FastBonus

Входной фильтр: идентификатор акции сгораемых бонусов

integer

None.

EventRule

Входной фильтр: идентификатор событийного правила

integer

None.

ChequeRule

Входной фильтр: идентификатор правила начисления бонусов на покупки

integer

None.

BonusMarketList

Входной фильтр: идентификатор правила начисления бонусов

integer

None.

Communication

Идентификатор рассылки

integer

None.

Report

Признак, что нужно вернуть данные для метода отчёта (вместе с detail = true)

boolean

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:
{
  "MarketList": 1,
  "Detail": true,
  "BegDate": "2024-06-16T12:36:15.0504166+03:00",
  "EndDate": "2024-06-16T12:36:15.0504166+03:00",
  "FastBonus": 1,
  "EventRule": 1,
  "ChequeRule": 1,
  "BonusMarketList": 1,
  "Communication": 1,
  "Report": true,
  "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 1"
}

application/xml, text/xml

Sample:
<MarketlistPurchasesRequest 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 1</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2024-06-16T12:36:15.0504166+03:00</BegDate>
  <BonusMarketList>1</BonusMarketList>
  <ChequeRule>1</ChequeRule>
  <Communication>1</Communication>
  <Detail>true</Detail>
  <EndDate>2024-06-16T12:36:15.0504166+03:00</EndDate>
  <EventRule>1</EventRule>
  <FastBonus>1</FastBonus>
  <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>
  <MarketList>1</MarketList>
  <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>
  <Report>true</Report>
</MarketlistPurchasesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MarketlistPurchasesResponse
NameDescriptionTypeAdditional information
Data

Данные

Collection of MarketlistPurchasesData

None.

CountMarketList

Количество клиентов в маркетинговом списке

integer

None.

CountMailing

Количество клиентов, которым была отправлена рассылка

integer

None.

CountDelivered

Количество клиентов, которые получили рассылку

integer

None.

CountNotDelivered

Количество клиентов, которые НЕ получили рассылку

integer

None.

CountResponse

Количество клиентов, которые совершили покупку в заданный период

integer

None.

Conversion

Конверсия в покупку (получили/совершили покупку)

decimal number

None.

MailingPrice

Стоимость рассылки

decimal number

None.

CommunicationType

Тип рассылки

byte

None.

CountPurchases

Общее количество покупок

integer

None.

PurchaseInClient

Количество покупок на клиента

decimal number

None.

Bonus

Количество бонусов, которые начислялись

decimal number

None.

CountNoBonus

Количество клиентов, которые не списали бонусы

integer

None.

CountBonus

Количество клиентов, которые списали бонусы

integer

None.

Gain

Выручка по акции или рассылке

decimal number

None.

GainNoBonus

Выручка клиентов, которые не списали бонусы

decimal number

None.

Redeemed

Списано бонусов всего

decimal number

None.

AvgCheque

Средний чек покупки

decimal number

None.

CountPurchasesRule

Общее количество покупок по указанному правилу/правилам

integer

None.

GainRule

Выручка клиентов по указанному правилу/правилам

decimal number

None.

BonusRule

Количество бонусов, начисленных по указанному правилу/правилам

decimal number

None.

AvgChequeRule

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

decimal number

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "Card": 1,
      "CountCheque": 1,
      "Amount": 1.0,
      "Bonus": 1.0,
      "PaidByBonus": 1.0,
      "Gain": 1.0
    },
    {
      "Card": 1,
      "CountCheque": 1,
      "Amount": 1.0,
      "Bonus": 1.0,
      "PaidByBonus": 1.0,
      "Gain": 1.0
    }
  ],
  "CountMarketList": 1,
  "CountMailing": 1,
  "CountDelivered": 1,
  "CountNotDelivered": 1,
  "CountResponse": 1,
  "Conversion": 1.0,
  "MailingPrice": 1.0,
  "CommunicationType": 64,
  "CountPurchases": 1,
  "PurchaseInClient": 1.0,
  "Bonus": 1.0,
  "CountNoBonus": 1,
  "CountBonus": 1,
  "Gain": 1.0,
  "GainNoBonus": 1.0,
  "Redeemed": 1.0,
  "AvgCheque": 1.0,
  "CountPurchasesRule": 1,
  "GainRule": 1.0,
  "BonusRule": 1.0,
  "AvgChequeRule": 1.0,
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<MarketlistPurchasesResponse 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>
  <AvgCheque>1</AvgCheque>
  <AvgChequeRule>1</AvgChequeRule>
  <Bonus>1</Bonus>
  <BonusRule>1</BonusRule>
  <CommunicationType>64</CommunicationType>
  <Conversion>1</Conversion>
  <CountBonus>1</CountBonus>
  <CountDelivered>1</CountDelivered>
  <CountMailing>1</CountMailing>
  <CountMarketList>1</CountMarketList>
  <CountNoBonus>1</CountNoBonus>
  <CountNotDelivered>1</CountNotDelivered>
  <CountPurchases>1</CountPurchases>
  <CountPurchasesRule>1</CountPurchasesRule>
  <CountResponse>1</CountResponse>
  <Data>
    <MarketlistPurchasesResponse.MarketlistPurchasesData>
      <Amount>1</Amount>
      <Bonus>1</Bonus>
      <Card>1</Card>
      <CountCheque>1</CountCheque>
      <Gain>1</Gain>
      <PaidByBonus>1</PaidByBonus>
    </MarketlistPurchasesResponse.MarketlistPurchasesData>
    <MarketlistPurchasesResponse.MarketlistPurchasesData>
      <Amount>1</Amount>
      <Bonus>1</Bonus>
      <Card>1</Card>
      <CountCheque>1</CountCheque>
      <Gain>1</Gain>
      <PaidByBonus>1</PaidByBonus>
    </MarketlistPurchasesResponse.MarketlistPurchasesData>
  </Data>
  <Gain>1</Gain>
  <GainNoBonus>1</GainNoBonus>
  <GainRule>1</GainRule>
  <MailingPrice>1</MailingPrice>
  <PurchaseInClient>1</PurchaseInClient>
  <Redeemed>1</Redeemed>
</MarketlistPurchasesResponse>