POST api/coupon/CouponChequesPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

CouponChequesPagingInfoRequest
NameDescriptionTypeAdditional information
Coupon

Входной фильтр: купон/промодк

string

None.

Pos

Входной фильтр: идентификатор точки продаж, по которой нужно вернуть данные

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:
{
  "Coupon": "sample string 1",
  "Pos": 1,
  "BegDate": "2025-06-19T06:19:21.7385754+03:00",
  "EndDate": "2025-06-19T06:19:21.7385754+03:00",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<CouponChequesPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.CouponRequest">
  <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>2025-06-19T06:19:21.7385754+03:00</BegDate>
  <Coupon>sample string 1</Coupon>
  <EndDate>2025-06-19T06:19:21.7385754+03:00</EndDate>
  <Length>1</Length>
  <Pos>1</Pos>
  <Start>1</Start>
</CouponChequesPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CouponChequesPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

Data

Итоговая информация

Collection of CouponChequesPagingInfoDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "Pos": 1,
      "PosName": "sample string 1",
      "Coupon": "sample string 2",
      "ProcTime": "2025-06-19T06:19:21.9573281+03:00",
      "Amount": 1.0,
      "Discount": 1.0,
      "ChequeNumber": "sample string 3",
      "ChequeId": 1,
      "Refund": "sample string 4",
      "ClientCard": 1,
      "ClientPhone": 1
    },
    {
      "Id": 1,
      "Pos": 1,
      "PosName": "sample string 1",
      "Coupon": "sample string 2",
      "ProcTime": "2025-06-19T06:19:21.9573281+03:00",
      "Amount": 1.0,
      "Discount": 1.0,
      "ChequeNumber": "sample string 3",
      "ChequeId": 1,
      "Refund": "sample string 4",
      "ClientCard": 1,
      "ClientPhone": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<CouponChequesPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.CouponResponse">
  <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>
  <Data>
    <CouponChequesPagingInfoResponse.CouponChequesPagingInfoDataRow>
      <Amount>1</Amount>
      <ChequeId>1</ChequeId>
      <ChequeNumber>sample string 3</ChequeNumber>
      <ClientCard>1</ClientCard>
      <ClientPhone>1</ClientPhone>
      <Coupon>sample string 2</Coupon>
      <Discount>1</Discount>
      <Id>1</Id>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <ProcTime>2025-06-19T06:19:21.9573281+03:00</ProcTime>
      <Refund>sample string 4</Refund>
    </CouponChequesPagingInfoResponse.CouponChequesPagingInfoDataRow>
    <CouponChequesPagingInfoResponse.CouponChequesPagingInfoDataRow>
      <Amount>1</Amount>
      <ChequeId>1</ChequeId>
      <ChequeNumber>sample string 3</ChequeNumber>
      <ClientCard>1</ClientCard>
      <ClientPhone>1</ClientPhone>
      <Coupon>sample string 2</Coupon>
      <Discount>1</Discount>
      <Id>1</Id>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <ProcTime>2025-06-19T06:19:21.9573281+03:00</ProcTime>
      <Refund>sample string 4</Refund>
    </CouponChequesPagingInfoResponse.CouponChequesPagingInfoDataRow>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</CouponChequesPagingInfoResponse>