Back

Search

Search

Methods

Inventory

Orders

Dashboards /GetTopProducts

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

HTTP Endpoint

Server /Dashboards / GetTopProducts

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/Dashboards/GetTopProducts HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

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

Response

This is an example response. Results may vary depending on your data.

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