Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Dashboards /GetTopProducts

Allows 150 calls per minute

Response: List<TopProductData>



Use this call to retrieve report about "Top ordered products" for top "10" products

Parameters

NameTypeDescription
typeTopProductsTypeUsed to specify type of report: 1 - group result by quantity, 2 - group result by turnover
periodInt32Used to specify report number of months
numRowsInt32Number of rows required
orderStatusInt32Order status

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Dashboards/GetTopProducts

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

type=1&period=1&numRows=1&orderStatus=1

Response

This is an example of the response JSON. Results will vary depending on your data.

[
  {
    "RowNum": 1,
    "Quantity": 2,
    "Cost": 3.1,
    "Title": "sample string 4",
    "SKU": "sample string 5",
    "Currency": "sample string 6"
  }
]