Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

RulesEngine /GetRulesByType

Allows 150 calls per minute

Response: List<RuleHeaderBasic>



Use this call to retrieve a list of rules of a given type

Parameters

NameTypeDescription
typeRuleSetTypeThe rule type.

Permissions

GlobalPermissions.OrderBook.RulesEngineNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/RulesEngine/GetRulesByType

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

Response

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

[
  {
    "pkRuleId": 1,
    "RuleName": "sample string 2",
    "Enabled": true,
    "RunOrder": 4,
    "RuleType": 1,
    "pkRuleId_Draft": 1,
    "Draft": true,
    "RuleTypeDisplayName": "Test"
  }
]