Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ImportExport /GetExport

Allows 150 calls per minute

Response: Export



Get an export configuration

Parameters

NameTypeDescription
idInt32Id of the export to get

Permissions

GlobalPermissions.Settings.ImportExport.ExportNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ImportExport/GetExport

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.

id=1

Response

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

{
  "Specification": {
    "ExportColumnNames": true,
    "Delimiter": "sample string 2",
    "Escape": "sample string 3",
    "CustomScript": "sample string 4",
    "Feed": null,
    "ColumnMappings": [
      {
        "Order": 1,
        "Filters": {
          "NumericFilters": [
            {
              "Type": 0,
              "Value": 1.0
            }
          ],
          "BooleanFilter": {
            "Value": true
          },
          "DateRangeFilters": [
            {
              "ValueFrom": "2021-07-29T09:24:36.1160412+01:00",
              "ValueTo": "2021-07-29T09:24:36.1160412+01:00",
              "Days": 3,
              "Enabled": true,
              "Type": "sample string 5"
            }
          ],
          "StringFilters": [
            {
              "Type": 0,
              "Value": "sample string 1"
            }
          ]
        },
        "ExportToFile": true,
        "SubQuerySelection": [
          {
            "SelectionFieldName": "sample string 1",
            "SelectionFieldValue": "sample string 2"
          }
        ],
        "FileColumn": "sample string 3",
        "Column": "sample string 4",
        "Expression": "sample string 5",
        "DefaultValue": "sample string 6",
        "Visible": true
      }
    ],
    "ExecutionOptions": [
      {
        "OptionDetails": {
          "Type": "sample string 1",
          "Key": "sample string 2"
        },
        "DisplayName": "sample string 1",
        "Value": {
        }
      }
    ]
  },
  "Register": {
    "LastQueryExecuted": "2021-07-29T09:24:36.1166978+01:00",
    "LastExportStatus": true,
    "Id": 2,
    "Type": "sample string 3",
    "FriendlyName": "sample string 4",
    "Executing": true,
    "justOnce": true,
    "Started": "2021-07-29T09:24:36.1166978Z",
    "Completed": "2021-07-29T09:24:36.1166978Z",
    "IsQueued": true,
    "Enabled": true,
    "IsNew": false,
    "AllSchedulesDisabled": false,
    "NextSchedule": null
  },
  "Schedules": [
    {
      "Id": 1,
      "Order": 2,
      "Name": "sample string 3",
      "ScheduleXML": "sample string 4",
      "Configuration": {
        "RepetitionType": 0,
        "OneTimeDate": "2021-07-29T09:24:36.1166978Z",
        "DailyFrequency": 0,
        "OccursFrequencyStartingDate": "2021-07-29T09:24:36.1166978Z",
        "OccursFrequencyEveryX": 1,
        "WeeklyDays": "sample string 1",
        "OccursFrequency": 0,
        "OccursOnceAtTime": "sample string 2",
        "OccursEveryHours": 1,
        "StartingTime": "sample string 3",
        "EndingTime": "sample string 4",
        "Enabled": true
      }
    }
  ]
}