POST api/reports/ABCReview

Отчёт о вкладе клиентов в выручку торговых точек (группы А, B, С) с определением маркера активности (Горячий, Тёплый, Холодный) за определённый период

Request Information

URI Parameters

None.

Body Parameters

ABCReviewRequest
NameDescriptionTypeAdditional information
Partner

Идентификатор партнера

integer

None.

PosCode

Код торговой точки

string

None.

NoCurrentMonth

Признак исключения из выборки данных за неполный (текущий) месяц

boolean

None.

FilterPos

Фильтр: идентификатор торговой точки, выручка и клиенты которой будут разложены на категории АВС

integer

None.

FilterPartner

Фильтр: идентификатор партнера, выручка и клиенты которого будут разложены на категории АВС

integer

None.

Hot

Фильтр: кол-во месяцев назад, в которых была дата последней покупки клиента, чтобы он считался "горячим"

byte

None.

Warm

Фильтр: кол-во месяцев назад, от последнего месяца @hot-фильтра, который был указан, в которых есть дата последней покупки клиента, чтобы он считался "тёплым"

byte

None.

GroupA

Фильтр: задаваемый % от общей выручки для группы А (в неё войдут самые прибыльные клиенты, которые и делают заданный % выручки)

byte

None.

GroupB

Фильтр: задаваемый % от общей выручки для группы B (в неё войдут следующие после самых прибыльных, который и делают заданный % выручки)

byte

None.

MonthAgo

Фильтр: количество месяцев назад от текущего, чтобы понять за какой период анализируем выручку и клиентов для проведения анализа

byte

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Partner": 1,
  "PosCode": "sample string 1",
  "NoCurrentMonth": true,
  "FilterPos": 1,
  "FilterPartner": 1,
  "Hot": 64,
  "Warm": 64,
  "GroupA": 64,
  "GroupB": 64,
  "MonthAgo": 64,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<ABCReviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.ReportsRequest">
  <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>
  <FilterPartner>1</FilterPartner>
  <FilterPos>1</FilterPos>
  <GroupA>64</GroupA>
  <GroupB>64</GroupB>
  <Hot>64</Hot>
  <MonthAgo>64</MonthAgo>
  <NoCurrentMonth>true</NoCurrentMonth>
  <Partner>1</Partner>
  <PosCode>sample string 1</PosCode>
  <Warm>64</Warm>
</ABCReviewRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ABCReviewReportResponse
NameDescriptionTypeAdditional information
Report

Бинарные данные отчёта

Collection of byte

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Report": "QEA=",
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ABCReviewReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.ReportsResponse">
  <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>
  <Report>QEA=</Report>
</ABCReviewReportResponse>