Back

Search

Search

Methods

Inventory

Orders

OpenOrders /GetAvailableFields

Rate Limit: 150/min

Response: VisibleFieldGroup[]


Parameters

NameTypeDescription
requestGetAvailableFieldsRequest

HTTP Endpoint

Server /OpenOrders / GetAvailableFields

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/OpenOrders/GetAvailableFields 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

request={
  "ViewType": 0
}

Response

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

[
  {
    "SubFields": [
      {
        "FieldParameters": [
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "IsDisplay": true,
        "CanFilter": true,
        "CanSort": true,
        "FieldType": "Text",
        "Sorting": {
          "Direction": "Ascending",
          "Order": 64
        },
        "HasSorting": true,
        "Filters": [
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          },
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          }
        ],
        "HasFilters": true,
        "AllowCustom": true,
        "AllowFutureDates": true,
        "Code": "NONE",
        "Name": "sample string 6",
        "Description": "sample string 7",
        "IsVisible": true,
        "Width": "sample string 9",
        "Sequence": 10,
        "Pinned": "sample string 11"
      },
      {
        "FieldParameters": [
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "IsDisplay": true,
        "CanFilter": true,
        "CanSort": true,
        "FieldType": "Text",
        "Sorting": {
          "Direction": "Ascending",
          "Order": 64
        },
        "HasSorting": true,
        "Filters": [
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          },
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          }
        ],
        "HasFilters": true,
        "AllowCustom": true,
        "AllowFutureDates": true,
        "Code": "NONE",
        "Name": "sample string 6",
        "Description": "sample string 7",
        "IsVisible": true,
        "Width": "sample string 9",
        "Sequence": 10,
        "Pinned": "sample string 11"
      }
    ],
    "Code": "NONE",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "IsVisible": true,
    "Width": "sample string 4",
    "Sequence": 5,
    "Pinned": "sample string 6"
  },
  {
    "SubFields": [
      {
        "FieldParameters": [
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "IsDisplay": true,
        "CanFilter": true,
        "CanSort": true,
        "FieldType": "Text",
        "Sorting": {
          "Direction": "Ascending",
          "Order": 64
        },
        "HasSorting": true,
        "Filters": [
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          },
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          }
        ],
        "HasFilters": true,
        "AllowCustom": true,
        "AllowFutureDates": true,
        "Code": "NONE",
        "Name": "sample string 6",
        "Description": "sample string 7",
        "IsVisible": true,
        "Width": "sample string 9",
        "Sequence": 10,
        "Pinned": "sample string 11"
      },
      {
        "FieldParameters": [
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Key": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "IsDisplay": true,
        "CanFilter": true,
        "CanSort": true,
        "FieldType": "Text",
        "Sorting": {
          "Direction": "Ascending",
          "Order": 64
        },
        "HasSorting": true,
        "Filters": [
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          },
          {
            "FieldType": "Text",
            "FieldCode": "NONE",
            "Value": {}
          }
        ],
        "HasFilters": true,
        "AllowCustom": true,
        "AllowFutureDates": true,
        "Code": "NONE",
        "Name": "sample string 6",
        "Description": "sample string 7",
        "IsVisible": true,
        "Width": "sample string 9",
        "Sequence": 10,
        "Pinned": "sample string 11"
      }
    ],
    "Code": "NONE",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "IsVisible": true,
    "Width": "sample string 4",
    "Sequence": 5,
    "Pinned": "sample string 6"
  }
]