POST api/cheque/ChequeruleTrackingInfo

Получение статистической информации о выделенных для отслеживания правил на покупки

Request Information

URI Parameters

None.

Body Parameters

ChequeruleTrackingInfoRequest
NameDescriptionTypeAdditional information
PosCode

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

string

None.

ChequeRule

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

integer

None.

BegDate

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

date

None.

EndDate

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

date

None.

Detail

Признак, что нужно вернуть ответ с детализацией

boolean

None.

InRuleList

Список правил

Collection of ChequeruleTrackingInfoInRuleListRow

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "ChequeRule": 1,
  "BegDate": "2024-06-16T11:46:41.7323894+03:00",
  "EndDate": "2024-06-16T11:46:41.7323894+03:00",
  "Detail": true,
  "InRuleList": [
    {
      "Id": 1,
      "ChequeRule": 1,
      "EventRule": 1,
      "BonusMarketList": 1
    },
    {
      "Id": 1,
      "ChequeRule": 1,
      "EventRule": 1,
      "BonusMarketList": 1
    }
  ],
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<ChequeruleTrackingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.ChequeRequest">
  <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>
  <BegDate>2024-06-16T11:46:41.7323894+03:00</BegDate>
  <ChequeRule>1</ChequeRule>
  <Detail>true</Detail>
  <EndDate>2024-06-16T11:46:41.7323894+03:00</EndDate>
  <InRuleList>
    <ChequeruleTrackingInfoRequest.ChequeruleTrackingInfoInRuleListRow>
      <BonusMarketList>1</BonusMarketList>
      <ChequeRule>1</ChequeRule>
      <EventRule>1</EventRule>
      <Id>1</Id>
    </ChequeruleTrackingInfoRequest.ChequeruleTrackingInfoInRuleListRow>
    <ChequeruleTrackingInfoRequest.ChequeruleTrackingInfoInRuleListRow>
      <BonusMarketList>1</BonusMarketList>
      <ChequeRule>1</ChequeRule>
      <EventRule>1</EventRule>
      <Id>1</Id>
    </ChequeruleTrackingInfoRequest.ChequeruleTrackingInfoInRuleListRow>
  </InRuleList>
  <PosCode>sample string 1</PosCode>
</ChequeruleTrackingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChequeruleTrackingInfoResponse
NameDescriptionTypeAdditional information
Clients

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

integer

None.

Purchases

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

integer

None.

Gain

Выручка по чекам

decimal number

None.

PurchaseInClient

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

decimal number

None.

Bonus

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

decimal number

None.

Redeemed

Списано бонусов в чеки

decimal number

None.

AvgCheque

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

decimal number

None.

BonusRule

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

decimal number

None.

QuantityItems

Количество товара в позициях чеков, на которые сработали правила

integer

None.

Rules

Массив правил

Collection of ChequeruleTrackingInfoRuleRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Clients": 1,
  "Purchases": 1,
  "Gain": 1.0,
  "PurchaseInClient": 1.0,
  "Bonus": 1.0,
  "Redeemed": 1.0,
  "AvgCheque": 1.0,
  "BonusRule": 1.0,
  "QuantityItems": 1,
  "Rules": [
    {
      "Id": 1,
      "RuleId": 1,
      "ProcDate": "2024-06-16T11:46:41.7446047+03:00",
      "Client": 1,
      "Phone": 1,
      "Card": 1,
      "Cheque": 1,
      "ChequeNumber": "sample string 1",
      "BonusRule": 1.0,
      "QuantityItems": 1,
      "Pos": 1,
      "PosName": "sample string 2",
      "ChequeAmount": 1.0,
      "ChequeRedeemed": 1.0,
      "ChequeGain": 1.0
    },
    {
      "Id": 1,
      "RuleId": 1,
      "ProcDate": "2024-06-16T11:46:41.7446047+03:00",
      "Client": 1,
      "Phone": 1,
      "Card": 1,
      "Cheque": 1,
      "ChequeNumber": "sample string 1",
      "BonusRule": 1.0,
      "QuantityItems": 1,
      "Pos": 1,
      "PosName": "sample string 2",
      "ChequeAmount": 1.0,
      "ChequeRedeemed": 1.0,
      "ChequeGain": 1.0
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ChequeruleTrackingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.ChequeResponse">
  <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>
  <Bonus>1</Bonus>
  <BonusRule>1</BonusRule>
  <Clients>1</Clients>
  <Gain>1</Gain>
  <PurchaseInClient>1</PurchaseInClient>
  <Purchases>1</Purchases>
  <QuantityItems>1</QuantityItems>
  <Redeemed>1</Redeemed>
  <Rules>
    <ChequeruleTrackingInfoResponse.ChequeruleTrackingInfoRuleRow>
      <BonusRule>1</BonusRule>
      <Card>1</Card>
      <Cheque>1</Cheque>
      <ChequeAmount>1</ChequeAmount>
      <ChequeGain>1</ChequeGain>
      <ChequeNumber>sample string 1</ChequeNumber>
      <ChequeRedeemed>1</ChequeRedeemed>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 2</PosName>
      <ProcDate>2024-06-16T11:46:41.7446047+03:00</ProcDate>
      <QuantityItems>1</QuantityItems>
      <RuleId>1</RuleId>
    </ChequeruleTrackingInfoResponse.ChequeruleTrackingInfoRuleRow>
    <ChequeruleTrackingInfoResponse.ChequeruleTrackingInfoRuleRow>
      <BonusRule>1</BonusRule>
      <Card>1</Card>
      <Cheque>1</Cheque>
      <ChequeAmount>1</ChequeAmount>
      <ChequeGain>1</ChequeGain>
      <ChequeNumber>sample string 1</ChequeNumber>
      <ChequeRedeemed>1</ChequeRedeemed>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 2</PosName>
      <ProcDate>2024-06-16T11:46:41.7446047+03:00</ProcDate>
      <QuantityItems>1</QuantityItems>
      <RuleId>1</RuleId>
    </ChequeruleTrackingInfoResponse.ChequeruleTrackingInfoRuleRow>
  </Rules>
</ChequeruleTrackingInfoResponse>