POST api/v1/payment-method-usage-report

Name	Type	Additional information
ClientId	integer	None.
SellerId	integer	None.
PageNumber	integer	None.
PageSize	integer	None.
Search	string	None.
OrderBy	string	None.
OrderDir	string	None.
FromDate	date	None.
ToDate	date	None.

Request Formats

application/json, text/json

{
  "ClientId": 1,
  "SellerId": 2,
  "PageNumber": 3,
  "PageSize": 4,
  "Search": "sample string 5",
  "OrderBy": "sample string 6",
  "OrderDir": "sample string 7",
  "FromDate": "2026-02-05T05:27:39.7457013+00:00",
  "ToDate": "2026-02-05T05:27:39.7457013+00:00"
}

text/html

{"ClientId":1,"SellerId":2,"PageNumber":3,"PageSize":4,"Search":"sample string 5","OrderBy":"sample string 6","OrderDir":"sample string 7","FromDate":"2026-02-05T05:27:39.7457013+00:00","ToDate":"2026-02-05T05:27:39.7457013+00:00"}

application/xml, text/xml

<ProductsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Order">
  <ClientId>1</ClientId>
  <FromDate>2026-02-05T05:27:39.7457013+00:00</FromDate>
  <OrderBy>sample string 6</OrderBy>
  <OrderDir>sample string 7</OrderDir>
  <PageNumber>3</PageNumber>
  <PageSize>4</PageSize>
  <Search>sample string 5</Search>
  <SellerId>2</SellerId>
  <ToDate>2026-02-05T05:27:39.7457013+00:00</ToDate>
</ProductsRequest>

application/x-www-form-urlencoded

Sample not available.

Response Information

Description:

Return type: Collection of PaymentMethodUsageReport

Response Formats

application/json, text/json

[
  {
    "PaymentGateway": "sample string 1",
    "PaymentMethod": "sample string 2",
    "TotalOrders": 3,
    "TotalValue": 4.0,
    "NetTotalAmount": 5.0,
    "PerOfTotalOrders": 6.0,
    "AvgOrderValue": 7.0,
    "CancelledOrders": 8,
    "ReturnedOrders": 9,
    "TotalCount": 10,
    "ActiveOrders": 11
  },
  {
    "PaymentGateway": "sample string 1",
    "PaymentMethod": "sample string 2",
    "TotalOrders": 3,
    "TotalValue": 4.0,
    "NetTotalAmount": 5.0,
    "PerOfTotalOrders": 6.0,
    "AvgOrderValue": 7.0,
    "CancelledOrders": 8,
    "ReturnedOrders": 9,
    "TotalCount": 10,
    "ActiveOrders": 11
  }
]

text/html

[{"PaymentGateway":"sample string 1","PaymentMethod":"sample string 2","TotalOrders":3,"TotalValue":4.0,"NetTotalAmount":5.0,"PerOfTotalOrders":6.0,"AvgOrderValue":7.0,"CancelledOrders":8,"ReturnedOrders":9,"TotalCount":10,"ActiveOrders":11},{"PaymentGateway":"sample string 1","PaymentMethod":"sample string 2","TotalOrders":3,"TotalValue":4.0,"NetTotalAmount":5.0,"PerOfTotalOrders":6.0,"AvgOrderValue":7.0,"CancelledOrders":8,"ReturnedOrders":9,"TotalCount":10,"ActiveOrders":11}]

application/xml, text/xml

<ArrayOfPaymentMethodUsageReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Order">
  <PaymentMethodUsageReport>
    <ActiveOrders>11</ActiveOrders>
    <AvgOrderValue>7</AvgOrderValue>
    <CancelledOrders>8</CancelledOrders>
    <NetTotalAmount>5</NetTotalAmount>
    <PaymentGateway>sample string 1</PaymentGateway>
    <PaymentMethod>sample string 2</PaymentMethod>
    <PerOfTotalOrders>6</PerOfTotalOrders>
    <ReturnedOrders>9</ReturnedOrders>
    <TotalCount>10</TotalCount>
    <TotalOrders>3</TotalOrders>
    <TotalValue>4</TotalValue>
  </PaymentMethodUsageReport>
  <PaymentMethodUsageReport>
    <ActiveOrders>11</ActiveOrders>
    <AvgOrderValue>7</AvgOrderValue>
    <CancelledOrders>8</CancelledOrders>
    <NetTotalAmount>5</NetTotalAmount>
    <PaymentGateway>sample string 1</PaymentGateway>
    <PaymentMethod>sample string 2</PaymentMethod>
    <PerOfTotalOrders>6</PerOfTotalOrders>
    <ReturnedOrders>9</ReturnedOrders>
    <TotalCount>10</TotalCount>
    <TotalOrders>3</TotalOrders>
    <TotalValue>4</TotalValue>
  </PaymentMethodUsageReport>
</ArrayOfPaymentMethodUsageReport>