Back

Search

Search

Methods

Inventory

Orders

Macro /GetInstalledMacros

Allows 150 calls per minute

Response: GetInstalledMacrosResponse



Get a list of all macros and their related applications as installed on the users system

Parameters

NameTypeDescription
requestGetInstalledMacroRequestEmpty request in place for later extension

Permissions

GlobalPermissions.Applications.MacroConfigurationNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Macro/GetInstalledMacros

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.

request={}

Response

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

{
  "Macros": [
    {
      "ApplicationName": "sample string 1",
      "ApplicationLogo": "sample string 2",
      "MacroName": "sample string 3",
      "MacroDescription": "sample string 4",
      "ExecutionType": 0,
      "SourceCodeType": 0,
      "Parameters": [
        {
          "Type": "sample string 1",
          "Name": "sample string 2",
          "IsRequired": true,
          "DefaultValue": "sample string 4",
          "FriendlyName": "sample string 5",
          "ParameterDescription": "sample string 6",
          "RegexValidation": "sample string 7",
          "RegexErrorMessage": "sample string 8",
          "MustBeSpecified1": true,
          "isHidden": true,
          "isReadOnly": true,
          "GroupName": "sample string 12",
          "Sortorder": 13
        }
      ]
    }
  ]
}