POST api/client/ClientOrdersInfo

Информация о заказах клиента с детализацией или о конкретном заказе

Request Information

URI Parameters

None.

Body Parameters

ClientOrdersInfoRequest
NameDescriptionTypeAdditional information
Client

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

integer

None.

Order

Идентификатор заказа, информацию по которому нужно получить

integer

None.

Start

Пагинация: от какой позиции по счёту отображать данные

integer

None.

Length

Количество записей для отображения

integer

None.

OrderGoodName

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

string

None.

OrderBegDate

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

date

None.

OrderEndDate

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

date

None.

OrderDate

Фильтр: дата заказа

date

None.

OrderNumber

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

string

None.

InvoiceNumber

Фильтр: номер накладной в заказе

string

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Client": 1,
  "Order": 1,
  "Start": 1,
  "Length": 1,
  "OrderGoodName": "sample string 1",
  "OrderBegDate": "2024-04-26T04:25:16.1295459+03:00",
  "OrderEndDate": "2024-04-26T04:25:16.1295459+03:00",
  "OrderDate": "2024-04-26T04:25:16.1295459+03:00",
  "OrderNumber": "sample string 2",
  "InvoiceNumber": "sample string 3",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:
<ClientOrdersInfoRequest 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 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Client>1</Client>
  <InvoiceNumber>sample string 3</InvoiceNumber>
  <Length>1</Length>
  <Order>1</Order>
  <OrderBegDate>2024-04-26T04:25:16.1295459+03:00</OrderBegDate>
  <OrderDate>2024-04-26T04:25:16.1295459+03:00</OrderDate>
  <OrderEndDate>2024-04-26T04:25:16.1295459+03:00</OrderEndDate>
  <OrderGoodName>sample string 1</OrderGoodName>
  <OrderNumber>sample string 2</OrderNumber>
  <Start>1</Start>
</ClientOrdersInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClientOrdersInfoResponse
NameDescriptionTypeAdditional information
TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

Orders

Массив заказов

Collection of ClientOrdersInfoOrder

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Orders": [
    {
      "Id": 1,
      "OrderId": 1,
      "Guid": "sample string 1",
      "Status": "sample string 2",
      "Refund": true,
      "Amount": 1.0,
      "ChequeTime": "2024-04-26T04:25:16.3639253+03:00",
      "Number": "sample string 3",
      "PosName": "sample string 4",
      "StatusPayment": "sample string 5",
      "Redeemed": 1.0,
      "Added": 1.0,
      "SertRedeemed": 1.0,
      "Discount": 1.0,
      "Client": 1,
      "BarCode": 1,
      "ClientPhone": 1,
      "ClientFio": "sample string 6",
      "Comment": "sample string 7",
      "BonusHoldId": 1,
      "SertHoldId": 1,
      "OrderIdOut": "sample string 8",
      "OrderItems": [
        {
          "Id": 1,
          "Position": 1,
          "Name": "sample string 1",
          "Guid": "sample string 2",
          "ItemArticle": "sample string 3",
          "Price": 1.0,
          "MinPrice": 1.0,
          "Amount": 1.0,
          "Quantity": 1,
          "Redeemed": 1.0,
          "Added": 1.0,
          "SertRedeemed": 1.0,
          "Discount": 1.0,
          "Coupon": "sample string 4"
        },
        {
          "Id": 1,
          "Position": 1,
          "Name": "sample string 1",
          "Guid": "sample string 2",
          "ItemArticle": "sample string 3",
          "Price": 1.0,
          "MinPrice": 1.0,
          "Amount": 1.0,
          "Quantity": 1,
          "Redeemed": 1.0,
          "Added": 1.0,
          "SertRedeemed": 1.0,
          "Discount": 1.0,
          "Coupon": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "OrderId": 1,
      "Guid": "sample string 1",
      "Status": "sample string 2",
      "Refund": true,
      "Amount": 1.0,
      "ChequeTime": "2024-04-26T04:25:16.3639253+03:00",
      "Number": "sample string 3",
      "PosName": "sample string 4",
      "StatusPayment": "sample string 5",
      "Redeemed": 1.0,
      "Added": 1.0,
      "SertRedeemed": 1.0,
      "Discount": 1.0,
      "Client": 1,
      "BarCode": 1,
      "ClientPhone": 1,
      "ClientFio": "sample string 6",
      "Comment": "sample string 7",
      "BonusHoldId": 1,
      "SertHoldId": 1,
      "OrderIdOut": "sample string 8",
      "OrderItems": [
        {
          "Id": 1,
          "Position": 1,
          "Name": "sample string 1",
          "Guid": "sample string 2",
          "ItemArticle": "sample string 3",
          "Price": 1.0,
          "MinPrice": 1.0,
          "Amount": 1.0,
          "Quantity": 1,
          "Redeemed": 1.0,
          "Added": 1.0,
          "SertRedeemed": 1.0,
          "Discount": 1.0,
          "Coupon": "sample string 4"
        },
        {
          "Id": 1,
          "Position": 1,
          "Name": "sample string 1",
          "Guid": "sample string 2",
          "ItemArticle": "sample string 3",
          "Price": 1.0,
          "MinPrice": 1.0,
          "Amount": 1.0,
          "Quantity": 1,
          "Redeemed": 1.0,
          "Added": 1.0,
          "SertRedeemed": 1.0,
          "Discount": 1.0,
          "Coupon": "sample string 4"
        }
      ]
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ClientOrdersInfoResponse 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>
  <Orders>
    <ClientOrdersInfoResponse.ClientOrdersInfoOrder>
      <Added>1</Added>
      <Amount>1</Amount>
      <BarCode>1</BarCode>
      <BonusHoldId>1</BonusHoldId>
      <ChequeTime>2024-04-26T04:25:16.3639253+03:00</ChequeTime>
      <Client>1</Client>
      <ClientFio>sample string 6</ClientFio>
      <ClientPhone>1</ClientPhone>
      <Comment>sample string 7</Comment>
      <Discount>1</Discount>
      <Guid>sample string 1</Guid>
      <Id>1</Id>
      <Number>sample string 3</Number>
      <OrderId>1</OrderId>
      <OrderIdOut>sample string 8</OrderIdOut>
      <OrderItems>
        <ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
          <Added>1</Added>
          <Amount>1</Amount>
          <Coupon>sample string 4</Coupon>
          <Discount>1</Discount>
          <Guid>sample string 2</Guid>
          <Id>1</Id>
          <ItemArticle>sample string 3</ItemArticle>
          <MinPrice>1</MinPrice>
          <Name>sample string 1</Name>
          <Position>1</Position>
          <Price>1</Price>
          <Quantity>1</Quantity>
          <Redeemed>1</Redeemed>
          <SertRedeemed>1</SertRedeemed>
        </ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
        <ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
          <Added>1</Added>
          <Amount>1</Amount>
          <Coupon>sample string 4</Coupon>
          <Discount>1</Discount>
          <Guid>sample string 2</Guid>
          <Id>1</Id>
          <ItemArticle>sample string 3</ItemArticle>
          <MinPrice>1</MinPrice>
          <Name>sample string 1</Name>
          <Position>1</Position>
          <Price>1</Price>
          <Quantity>1</Quantity>
          <Redeemed>1</Redeemed>
          <SertRedeemed>1</SertRedeemed>
        </ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
      </OrderItems>
      <PosName>sample string 4</PosName>
      <Redeemed>1</Redeemed>
      <Refund>true</Refund>
      <SertHoldId>1</SertHoldId>
      <SertRedeemed>1</SertRedeemed>
      <Status>sample string 2</Status>
      <StatusPayment>sample string 5</StatusPayment>
    </ClientOrdersInfoResponse.ClientOrdersInfoOrder>
    <ClientOrdersInfoResponse.ClientOrdersInfoOrder>
      <Added>1</Added>
      <Amount>1</Amount>
      <BarCode>1</BarCode>
      <BonusHoldId>1</BonusHoldId>
      <ChequeTime>2024-04-26T04:25:16.3639253+03:00</ChequeTime>
      <Client>1</Client>
      <ClientFio>sample string 6</ClientFio>
      <ClientPhone>1</ClientPhone>
      <Comment>sample string 7</Comment>
      <Discount>1</Discount>
      <Guid>sample string 1</Guid>
      <Id>1</Id>
      <Number>sample string 3</Number>
      <OrderId>1</OrderId>
      <OrderIdOut>sample string 8</OrderIdOut>
      <OrderItems>
        <ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
          <Added>1</Added>
          <Amount>1</Amount>
          <Coupon>sample string 4</Coupon>
          <Discount>1</Discount>
          <Guid>sample string 2</Guid>
          <Id>1</Id>
          <ItemArticle>sample string 3</ItemArticle>
          <MinPrice>1</MinPrice>
          <Name>sample string 1</Name>
          <Position>1</Position>
          <Price>1</Price>
          <Quantity>1</Quantity>
          <Redeemed>1</Redeemed>
          <SertRedeemed>1</SertRedeemed>
        </ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
        <ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
          <Added>1</Added>
          <Amount>1</Amount>
          <Coupon>sample string 4</Coupon>
          <Discount>1</Discount>
          <Guid>sample string 2</Guid>
          <Id>1</Id>
          <ItemArticle>sample string 3</ItemArticle>
          <MinPrice>1</MinPrice>
          <Name>sample string 1</Name>
          <Position>1</Position>
          <Price>1</Price>
          <Quantity>1</Quantity>
          <Redeemed>1</Redeemed>
          <SertRedeemed>1</SertRedeemed>
        </ClientOrdersInfoResponse.ClientOrdersInfoOrder.ClientOrdersInfoOrderItem>
      </OrderItems>
      <PosName>sample string 4</PosName>
      <Redeemed>1</Redeemed>
      <Refund>true</Refund>
      <SertHoldId>1</SertHoldId>
      <SertRedeemed>1</SertRedeemed>
      <Status>sample string 2</Status>
      <StatusPayment>sample string 5</StatusPayment>
    </ClientOrdersInfoResponse.ClientOrdersInfoOrder>
  </Orders>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ClientOrdersInfoResponse>