POST TopPurchasedItems/Get

Gets a list of Top Purchased Items.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

Top Purchased Item Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

IncludeOption bool

None.

Gets or sets a value indicating the dashboard widget's boolean value.

ViewTop integer

None.

Gets or sets the View Top.

Request Formats

application/json, text/json

Sample:
{
  "IncludeOption": true,
  "ViewTop": 2,
  "FromDate": "2024-11-15",
  "ToDate": "2024-11-15"
}

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Top Purchased Item
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Top Purchased Item

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "ItemId": 1,
      "Description": "sample string 2",
      "Exclusive": 3.0,
      "Total": 4.0,
      "Quantity": 5.0
    },
    {
      "ItemId": 1,
      "Description": "sample string 2",
      "Exclusive": 3.0,
      "Total": 4.0,
      "Quantity": 5.0
    }
  ]
}