Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Dashboards /ExecuteCustomPagedScript

Allows 150 calls per minute

Response: CustomScriptResult



Use this call to retrieve Query Data report
Contact support with Query Data report name and we will provide you with parameters.

Parameters

NameTypeDescription
scriptIdInt32Used to specify custom paged script id
parametersList<ScriptParameter>Used to specify custom paged script conditional parameters
entriesPerPageInt32Used to specify number of entries per page in report
pageNumberInt32Used to specify custom paged script page number
cancellationTokenCancellationTokenTerminates execution if task was cancelled on client

Example Request

The following request format is required for this method.

Endpoint URL

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

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.

scriptId=1¶meters=[
  {
    "ParameterId": 1,
    "Type": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "DefaultValue": "sample string 5",
    "AvailableValues": [
      "sample string 1"
    ],
    "Value": {},
    "SortOrder": 10
  }
]&entriesPerPage=1&pageNumber=1&cancellationToken={
  "IsCancellationRequested": false,
  "CanBeCanceled": false,
  "WaitHandle": {
    "Handle": {
      "value": 1248
    },
    "SafeWaitHandle": {
      "IsInvalid": false,
      "IsClosed": false
    }
  }
}

Response

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

{
  "IsError": true,
  "ErrorMessage": "sample string 2",
  "TotalResults": 1,
  "Columns": [
    {
      "Index": 1,
      "Name": "sample string 2",
      "Type": "sample string 3"
    }
  ],
  "Results": [
    {
      "sample string 1": {
      }
    }
  ]
}