POST Report/Basic

Request Information

URI Parameters

None.

Body Parameters

BasicReportRequest
NameDescriptionTypeAdditional information
courier

integer

None.

date1

string

None.

date2

string

None.

Request Formats

application/json, text/json

Sample:
{
  "courier": 1,
  "date1": "sample string 2",
  "date2": "sample string 3"
}

application/xml, text/xml

Sample:
<BasicReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestAPI.Models">
  <courier>1</courier>
  <date1>sample string 2</date1>
  <date2>sample string 3</date2>
</BasicReportRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BasicReportRequest'.

Response Information

Resource Description

BasicReport
NameDescriptionTypeAdditional information
Count

integer

None.

TotalPrice

decimal number

None.

AveragePrice

decimal number

None.

Earning

decimal number

None.

Packages

Collection of SummaryItem

None.

Report

CourierPackageDeliveryReportItem

None.

Response Formats

application/json, text/json

Sample:
{
  "Count": 1,
  "TotalPrice": 2.0,
  "AveragePrice": 3.0,
  "Earning": 4.0,
  "Packages": [
    {
      "ID": 1,
      "Date": "2025-03-13T20:57:47.9846793+03:00",
      "Buyer": "sample string 3",
      "Price": 4.0,
      "Address": "sample string 5",
      "Channel": "sample string 6",
      "Payment": "sample string 7",
      "Courier": "sample string 8",
      "DeliveryPrice": 9.0
    },
    {
      "ID": 1,
      "Date": "2025-03-13T20:57:47.9846793+03:00",
      "Buyer": "sample string 3",
      "Price": 4.0,
      "Address": "sample string 5",
      "Channel": "sample string 6",
      "Payment": "sample string 7",
      "Courier": "sample string 8",
      "DeliveryPrice": 9.0
    }
  ],
  "Report": {
    "ID": 1,
    "Name": "sample string 2",
    "PPP": 3.1,
    "Count": 4,
    "Earning": 5.1,
    "Payments": {
      "Cash": 1.1,
      "Card": 2.1,
      "Online": 3.1,
      "FoodCard": 4.1,
      "OnlineFoodCard": 5.1,
      "Other": 6.1,
      "Commission": 7.1,
      "Total": 8.1
    }
  }
}

application/xml, text/xml

Sample:
<BasicReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestAPI.Models">
  <AveragePrice>3</AveragePrice>
  <Count>1</Count>
  <Earning>4</Earning>
  <Packages>
    <SummaryItem>
      <Address>sample string 5</Address>
      <Buyer>sample string 3</Buyer>
      <Channel>sample string 6</Channel>
      <Courier>sample string 8</Courier>
      <Date>2025-03-13T20:57:47.9846793+03:00</Date>
      <DeliveryPrice>9</DeliveryPrice>
      <ID>1</ID>
      <Payment>sample string 7</Payment>
      <Price>4</Price>
    </SummaryItem>
    <SummaryItem>
      <Address>sample string 5</Address>
      <Buyer>sample string 3</Buyer>
      <Channel>sample string 6</Channel>
      <Courier>sample string 8</Courier>
      <Date>2025-03-13T20:57:47.9846793+03:00</Date>
      <DeliveryPrice>9</DeliveryPrice>
      <ID>1</ID>
      <Payment>sample string 7</Payment>
      <Price>4</Price>
    </SummaryItem>
  </Packages>
  <Report>
    <Count>4</Count>
    <Earning>5.1</Earning>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <PPP>3.1</PPP>
    <Payments>
      <Card>2.1</Card>
      <Cash>1.1</Cash>
      <Commission>7.1</Commission>
      <FoodCard>4.1</FoodCard>
      <Online>3.1</Online>
      <OnlineFoodCard>5.1</OnlineFoodCard>
      <Other>6.1</Other>
      <Total>8.1</Total>
    </Payments>
  </Report>
  <TotalPrice>2</TotalPrice>
</BasicReport>