POST api/sertcard/SalesPaging

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

Request Information

URI Parameters

None.

Body Parameters

SalesPagingRequest
NameDescriptionTypeAdditional information
Partner

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

 integer

None.
PosCode

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

 string

None.
Report

Признак, что запрашивается отчёт, а не данные для таблицы

 boolean

None.
ProcTimeIn

Фильтр: точная дата

 date

None.
BegDate

Фильтр: начальная дата периода

 date

None.
EndDate

Фильтр: конечная дата периода

 date

None.
Pos

Фильтр: идентификатор точки продаж

 integer

None.
Phone

Фильтр: номер телефона клиента

 integer

None.
SertCard

Фильтр: номер подарочного сертификата

 integer

None.
SertCardType

Фильтр: тип подарочного сертификата (SertCardType = 1 - Пластиковый, SertCardType = 3 - Электронный)

 byte

None.
SertCardOwner

Фильтр: идентификатор владельца сертификата (актуально для эл. сертификатов, купленных через виджет)

 integer

None.
Client

Фильтр: идентификатор клиента

 integer

None.
Cheque

Фильтр: идентификатор чека продажи

 integer

None.
Refund

Фильтр: тип операции (покупка или возврат)

 boolean

None.
ChequeNumber

Фиильтр : номер чека продажи

 string

None.
Price

Фильтр: цена подарочного сертификата

 decimal number

None.
Start

Пагинация: начальная позиция для отображения

 integer

None.
Length

Пагинация: кол-во строк для отображения

 integer

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Partner": 1,
  "PosCode": "sample string 1",
  "Report": true,
  "ProcTimeIn": "2025-03-28T11:19:41.1366244+03:00",
  "BegDate": "2025-03-28T11:19:41.1366244+03:00",
  "EndDate": "2025-03-28T11:19:41.1366244+03:00",
  "Pos": 1,
  "Phone": 1,
  "SertCard": 1,
  "SertCardType": 64,
  "SertCardOwner": 1,
  "Client": 1,
  "Cheque": 1,
  "Refund": true,
  "ChequeNumber": "sample string 2",
  "Price": 1.0,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample: 
<SalesPagingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SertCardRequest">
  <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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2025-03-28T11:19:41.1366244+03:00</BegDate>
  <Cheque>1</Cheque>
  <ChequeNumber>sample string 2</ChequeNumber>
  <Client>1</Client>
  <EndDate>2025-03-28T11:19:41.1366244+03:00</EndDate>
  <Length>1</Length>
  <Partner>1</Partner>
  <Phone>1</Phone>
  <Pos>1</Pos>
  <PosCode>sample string 1</PosCode>
  <Price>1</Price>
  <ProcTimeIn>2025-03-28T11:19:41.1366244+03:00</ProcTimeIn>
  <Refund>true</Refund>
  <Report>true</Report>
  <SertCard>1</SertCard>
  <SertCardOwner>1</SertCardOwner>
  <SertCardType>64</SertCardType>
  <Start>1</Start>
</SalesPagingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SalesPagingResponse
NameDescriptionTypeAdditional information
TotalRows

Общее кол-во строк, которое может вернуться в выборке

 integer

None.
TotalRowsSelect

Общее кол-во строк, которое вернулось в запросе

 integer

None.
Serts

Сертификаты

 Collection of SalesPagingSert

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Serts": [
    {
      "Id": 1,
      "ChequeTime": "2025-03-28T11:19:41.3241237+03:00",
      "PosName": "sample string 1",
      "Pos": 1,
      "SertCard": 1,
      "Price": 1.0,
      "SertCardType": 64,
      "SertCardTypeName": "sample string 2",
      "Cheque": 1,
      "ChequeNumber": "sample string 3",
      "Refund": true,
      "SertCardOwner": 1,
      "Client": 1,
      "Phone": 1
    },
    {
      "Id": 1,
      "ChequeTime": "2025-03-28T11:19:41.3241237+03:00",
      "PosName": "sample string 1",
      "Pos": 1,
      "SertCard": 1,
      "Price": 1.0,
      "SertCardType": 64,
      "SertCardTypeName": "sample string 2",
      "Cheque": 1,
      "ChequeNumber": "sample string 3",
      "Refund": true,
      "SertCardOwner": 1,
      "Client": 1,
      "Phone": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<SalesPagingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SertCardResponse">
  <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>
  <Serts>
    <SalesPagingResponse.SalesPagingSert>
      <Cheque>1</Cheque>
      <ChequeNumber>sample string 3</ChequeNumber>
      <ChequeTime>2025-03-28T11:19:41.3241237+03:00</ChequeTime>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Price>1</Price>
      <Refund>true</Refund>
      <SertCard>1</SertCard>
      <SertCardOwner>1</SertCardOwner>
      <SertCardType>64</SertCardType>
      <SertCardTypeName>sample string 2</SertCardTypeName>
    </SalesPagingResponse.SalesPagingSert>
    <SalesPagingResponse.SalesPagingSert>
      <Cheque>1</Cheque>
      <ChequeNumber>sample string 3</ChequeNumber>
      <ChequeTime>2025-03-28T11:19:41.3241237+03:00</ChequeTime>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Price>1</Price>
      <Refund>true</Refund>
      <SertCard>1</SertCard>
      <SertCardOwner>1</SertCardOwner>
      <SertCardType>64</SertCardType>
      <SertCardTypeName>sample string 2</SertCardTypeName>
    </SalesPagingResponse.SalesPagingSert>
  </Serts>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</SalesPagingResponse>