POST api/client/ClientFavoriteDataInfo

Получение табличной и статистической информации по клиенту относительно его участия в механике "Любимый продукт"

Request Information

URI Parameters

None.

Body Parameters

ClientFavoriteDataInfoRequest
NameDescriptionTypeAdditional information
Client

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

 integer

None.
ClientFavoriteId

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

 integer

None.
ListDataId

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

 integer

None.
BegDate

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

 date

None.
EndDate

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

 date

None.
Start

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

 integer

None.
Length

Пагинация: количество записей, которые нужно вернуть

 integer

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Client": 1,
  "ClientFavoriteId": 1,
  "ListDataId": 1,
  "BegDate": "2026-05-07T11:27:39.5049468+03:00",
  "EndDate": "2026-05-07T11:27:39.5049468+03:00",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample: 
<ClientFavoriteDataInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request">
  <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>2026-05-07T11:27:39.5049468+03:00</BegDate>
  <Client>1</Client>
  <ClientFavoriteId>1</ClientFavoriteId>
  <EndDate>2026-05-07T11:27:39.5049468+03:00</EndDate>
  <Length>1</Length>
  <ListDataId>1</ListDataId>
  <Start>1</Start>
</ClientFavoriteDataInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClientFavoriteDataInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Количество записей всего

 integer

None.
TotalRowsSelect

Количество записей в запросе

 integer

None.
MaxLinkGoods

Максимальное количество товаров, которое можно выбрать в качестве любимого продукта

 integer

None.
NowLinkGoods

Текущее количество товаров, которое выбрано в качестве любимого продукта

 integer

None.
RemainLinkGoods

Количество товаров, которое осталось выбрать из возможных

 integer

None.
RemainCountPurchases

Количество покупок, которые необходимо клиенту сделать, чтобы появилась возможность выбрать любимый продукт

 integer

None.
RemainGain

Сумма денег, которые нужно потратить клиенту, чтобы появилась возможность выбрать любимый продукт

 decimal number

None.
RemainEveryGain

Сумма денег, каждой покупки, которые нужно потратить клиенту, чтобы появилась возможность выбрать любимый продукт

 decimal number

None.
CountOffer

Сколько раз за период (или всё время) клиенту предлагали любимый продукт

 integer

None.
CountConfirm

Сколько раз за период (или всё время) клиент подтверждал участие в механике любимый продукт

 integer

None.
CountPurchases

Сколько покупок клиент совершил, в которых был любимый продукт

 integer

None.
SumGain

Сколько денег потратил на покупки, в которых был любимый продукт

 decimal number

None.
AvgFavorite

Средний чек клиента по покупкам, в которых был любимый продукт

 decimal number

None.
AvgAll

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

 decimal number

None.
ClientFavorites

Массив событий в любимом продукте по клиенту

 Collection of ClientFavoriteDataInfoClientFavoritesRow

None.
ListFavorites

Массив товаров по идентификатору попадания в любимый продукт

 Collection of ClientFavoriteDataInfoListFavoritesRow

None.
GroupFavorites

Массив выборов товаров, в качестве любимого продукта

 Collection of ClientFavoriteDataInfoGroupFavoritesRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "MaxLinkGoods": 1,
  "NowLinkGoods": 1,
  "RemainLinkGoods": 1,
  "RemainCountPurchases": 1,
  "RemainGain": 1.0,
  "RemainEveryGain": 1.0,
  "CountOffer": 1,
  "CountConfirm": 1,
  "CountPurchases": 1,
  "SumGain": 1.0,
  "AvgFavorite": 1.0,
  "AvgAll": 1.0,
  "ClientFavorites": [
    {
      "Id": 1,
      "ProcTime": "2026-05-07T11:27:39.5205698+03:00",
      "ConfirmDateEnd": "2026-05-07T11:27:39.5205698+03:00",
      "Confirm": true,
      "ProcTimeConfirm": "2026-05-07T11:27:39.5205698+03:00",
      "ActionDateEnd": "2026-05-07T11:27:39.5205698+03:00",
      "NoActive": true
    },
    {
      "Id": 1,
      "ProcTime": "2026-05-07T11:27:39.5205698+03:00",
      "ConfirmDateEnd": "2026-05-07T11:27:39.5205698+03:00",
      "Confirm": true,
      "ProcTimeConfirm": "2026-05-07T11:27:39.5205698+03:00",
      "ActionDateEnd": "2026-05-07T11:27:39.5205698+03:00",
      "NoActive": true
    }
  ],
  "ListFavorites": [
    {
      "Id": 1,
      "ListDataId": 1,
      "UrlImage": "sample string 1",
      "Name": "sample string 2",
      "Code": "sample string 3",
      "NoActive": true
    },
    {
      "Id": 1,
      "ListDataId": 1,
      "UrlImage": "sample string 1",
      "Name": "sample string 2",
      "Code": "sample string 3",
      "NoActive": true
    }
  ],
  "GroupFavorites": [
    {
      "Id": 1,
      "Name": "sample string 1",
      "CountSelect": 1
    },
    {
      "Id": 1,
      "Name": "sample string 1",
      "CountSelect": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<ClientFavoriteDataInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response">
  <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>
  <AvgAll>1</AvgAll>
  <AvgFavorite>1</AvgFavorite>
  <ClientFavorites>
    <ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoClientFavoritesRow>
      <ActionDateEnd>2026-05-07T11:27:39.5205698+03:00</ActionDateEnd>
      <Confirm>true</Confirm>
      <ConfirmDateEnd>2026-05-07T11:27:39.5205698+03:00</ConfirmDateEnd>
      <Id>1</Id>
      <NoActive>true</NoActive>
      <ProcTime>2026-05-07T11:27:39.5205698+03:00</ProcTime>
      <ProcTimeConfirm>2026-05-07T11:27:39.5205698+03:00</ProcTimeConfirm>
    </ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoClientFavoritesRow>
    <ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoClientFavoritesRow>
      <ActionDateEnd>2026-05-07T11:27:39.5205698+03:00</ActionDateEnd>
      <Confirm>true</Confirm>
      <ConfirmDateEnd>2026-05-07T11:27:39.5205698+03:00</ConfirmDateEnd>
      <Id>1</Id>
      <NoActive>true</NoActive>
      <ProcTime>2026-05-07T11:27:39.5205698+03:00</ProcTime>
      <ProcTimeConfirm>2026-05-07T11:27:39.5205698+03:00</ProcTimeConfirm>
    </ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoClientFavoritesRow>
  </ClientFavorites>
  <CountConfirm>1</CountConfirm>
  <CountOffer>1</CountOffer>
  <CountPurchases>1</CountPurchases>
  <GroupFavorites>
    <ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoGroupFavoritesRow>
      <CountSelect>1</CountSelect>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoGroupFavoritesRow>
    <ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoGroupFavoritesRow>
      <CountSelect>1</CountSelect>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoGroupFavoritesRow>
  </GroupFavorites>
  <ListFavorites>
    <ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoListFavoritesRow>
      <Code>sample string 3</Code>
      <Id>1</Id>
      <ListDataId>1</ListDataId>
      <Name>sample string 2</Name>
      <NoActive>true</NoActive>
      <UrlImage>sample string 1</UrlImage>
    </ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoListFavoritesRow>
    <ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoListFavoritesRow>
      <Code>sample string 3</Code>
      <Id>1</Id>
      <ListDataId>1</ListDataId>
      <Name>sample string 2</Name>
      <NoActive>true</NoActive>
      <UrlImage>sample string 1</UrlImage>
    </ClientFavoriteDataInfoResponse.ClientFavoriteDataInfoListFavoritesRow>
  </ListFavorites>
  <MaxLinkGoods>1</MaxLinkGoods>
  <NowLinkGoods>1</NowLinkGoods>
  <RemainCountPurchases>1</RemainCountPurchases>
  <RemainEveryGain>1</RemainEveryGain>
  <RemainGain>1</RemainGain>
  <RemainLinkGoods>1</RemainLinkGoods>
  <SumGain>1</SumGain>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ClientFavoriteDataInfoResponse>