Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

RulesEngine /GetRequiredFieldsByType

Allows 150 calls per minute

Response: RulesFields



Use this call to get a list of fields and keys used by a given rule 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/GetRequiredFieldsByType

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.

{
  "FieldNames": [
    "sample string 1"
  ],
  "FieldKeys": {
    "sample string 1": [
      "sample string 1"
    ]
  },
  "IdName": "sample string 1"
}