Back

Search

Search

Methods

Inventory

Orders

Orders /GetOpenOrders

Response: GenericPagedResult<OpenOrder>



Get a paged list of open orders

Parameters

NameTypeDescription
entriesPerPageInt32Entries per page
pageNumberInt32Page number
filtersFieldsFilterFilters to apply
sortingList<FieldSorting>Sorting to apply
fulfilmentCenterNullable<Guid>Location to get the orders for
additionalFilterStringAdditional filter

HTTP Endpoint

Server /Orders / GetOpenOrders

Permissions

GlobalPermissions.OrderBook.OpenOrdersNode

Example Code

Example Request

The following request format is required for this method.

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

entriesPerPage=1&pageNumber=1&sorting=[
  {
    "FieldCode": 0,
    "Direction": 0,
    "Order": 1
  },
  {
    "FieldCode": 0,
    "Direction": 0,
    "Order": 1
  }
]&fulfilmentCenter=1d25de22-4aa0-4956-818d-abef5dfb41d0&additionalFilter=sample string 1

Response

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

{
  "PageNumber": 1,
  "EntriesPerPage": 2,
  "TotalEntries": 3,
  "TotalPages": 2,
  "Data": [
    {
      "NumOrderId": 1,
      "GeneralInfo": {
        "Status": 1,
        "LabelPrinted": true,
        "LabelError": "sample string 3",
        "InvoicePrinted": true,
        "PickListPrinted": true,
        "IsRuleRun": true,
        "Notes": 7,
        "PartShipped": true,
        "Marker": 64,
        "IsParked": true,
        "Identifiers": [
          {
            "IdentifierId": 1,
            "IsCustom": true,
            "ImageId": "80be0a10-f6fb-4ead-b805-72260f02977c",
            "ImageUrl": "sample string 4",
            "Tag": "sample string 5",
            "Name": "sample string 6"
          },
          {
          }
        ],
        "ReferenceNum": "sample string 10",
        "SecondaryReference": "sample string 11",
        "ExternalReferenceNum": "sample string 12",
        "ReceivedDate": "2019-11-28T09:46:01.7270868+00:00",
        "Source": "sample string 14",
        "SubSource": "sample string 15",
        "SiteCode": "sample string 16",
        "HoldOrCancel": true,
        "DespatchByDate": "2019-11-28T09:46:01.7270868+00:00",
        "ScheduledDelivery": {
          "From": "2019-11-28T09:46:01.7270868+00:00",
          "To": "2019-11-28T09:46:01.7270868+00:00"
        },
        "HasScheduledDelivery": true,
        "Location": "c522adad-016b-4eae-bbdd-fdcc0dff7405",
        "NumItems": 20,
        "StockAllocationType": 0
      },
      "ShippingInfo": {
        "Vendor": "sample string 1",
        "PostalServiceId": "55595a8b-5cde-4600-8eb7-d90ea9b234ce",
        "PostalServiceName": "sample string 3",
        "TotalWeight": 4.1,
        "ItemWeight": 5.1,
        "PackageCategoryId": "2fd512b0-6ebb-4b18-b7b6-df96152eee88",
        "PackageCategory": "sample string 7",
        "PackageTypeId": "9845ec8f-e7bb-46a2-8b22-4832d03f185b",
        "PackageType": "sample string 8",
        "PostageCost": 9.1,
        "PostageCostExTax": 10.1,
        "TrackingNumber": "sample string 11",
        "ManualAdjust": true
      },
      "CustomerInfo": {
        "ChannelBuyerName": "sample string 1",
        "Address": {
          "EmailAddress": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "Address3": "sample string 4",
          "Town": "sample string 5",
          "Region": "sample string 6",
          "PostCode": "sample string 7",
          "Country": "sample string 8",
          "Continent": "sample string 9",
          "FullName": "sample string 10",
          "Company": "sample string 11",
          "PhoneNumber": "sample string 12",
          "CountryId": "472fe39c-3800-443c-ad74-a7527590f95e"
        },
        "BillingAddress": {
        }
      },
      "TotalsInfo": {
        "Subtotal": 1.1,
        "PostageCost": 2.1,
        "Tax": 3.1,
        "TotalCharge": 4.1,
        "PaymentMethod": "sample string 5",
        "PaymentMethodId": "3b770f52-5639-4a19-91f2-d01126fa679e",
        "ProfitMargin": 7.1,
        "TotalDiscount": 8.1,
        "Currency": "sample string 9",
        "CountryTaxRate": 10.1,
        "ConversionRate": 11.1
      },
      "FolderName": [
        "sample string 1",
        "sample string 2"
      ],
      "IsPostFilteredOut": true,
      "CanFulfil": true,
      "Items": [
        {
          "ItemId": "eabff19f-5bdd-4ad4-b8ce-c7df05568b00",
          "ItemNumber": "sample string 2",
          "SKU": "sample string 3",
          "ItemSource": "sample string 4",
          "Title": "sample string 5",
          "Quantity": 6,
          "CategoryName": "sample string 8",
          "CompositeAvailablity": 1,
          "StockLevelsSpecified": true,
          "OnOrder": 10,
          "OnPurchaseOrder": {
            "pkPurchaseItemId": "8fe0effa-35e4-42ff-8cbe-07e9c888dcaf",
            "Rowid": "8a3efa0f-9ed3-4cd7-a0da-e6f8dfe3b909",
            "pkPurchaseId": "8d979785-52a9-4057-9cdc-73d408b4a036",
            "ExternalInvoiceNumber": "sample string 4",
            "fkSupplierId": "7f91b6bc-e978-4dae-b1d5-7641ac6de952",
            "DateOfDelivery": "2019-11-28T09:46:01.7270868+00:00",
            "QuotedDeliveryDate": "2019-11-28T09:46:01.7270868+00:00",
            "SupplierName": "sample string 8",
            "fkLocationId": "c8ec2926-9949-4986-84de-d757b6f84b19"
          },
          "InOrderBook": 1,
          "Level": 11,
          "MinimumLevel": 1,
          "AvailableStock": 12,
          "PricePerUnit": 13.1,
          "UnitCost": 14.1,
          "DespatchStockUnitCost": 15.1,
          "Discount": 16.1,
          "Tax": 21.1,
          "TaxRate": 17.1,
          "Cost": 18.1,
          "CostIncTax": 19.1,
          "CompositeSubItems": [
            {
            },
            {
            }
          ],
          "IsService": true,
          "SalesTax": 21.1,
          "TaxCostInclusive": true,
          "PartShipped": true,
          "Weight": 24.1,
          "BarcodeNumber": "sample string 25",
          "Market": 26,
          "ChannelSKU": "sample string 27",
          "ChannelTitle": "sample string 28",
          "DiscountValue": 10.806660973526899,
          "HasImage": true,
          "ImageId": "e877e685-3b57-44e4-a443-a25b45851402",
          "AdditionalInfo": [
            {
              "pkOptionId": "b58da438-0bb4-4cff-8a07-bcc702c6b6f5",
              "Property": "sample string 2",
              "Value": "sample string 3"
            },
            {
            }
          ],
          "StockLevelIndicator": 29,
          "BatchNumberScanRequired": true,
          "SerialNumberScanRequired": true,
          "BinRack": "sample string 32",
          "BinRacks": [
            {
              "Quantity": 1,
              "BinRack": "sample string 2",
              "Location": "43a18f26-ee37-42ad-8061-e16ac814dece",
              "BatchId": 1,
              "OrderItemBatchId": 1
            },
            {
            }
          ],
          "InventoryTrackingType": 33,
          "isBatchedStockItem": false,
          "IsWarehouseManaged": true,
          "HasPurchaseOrders": true,
          "CanPurchaseOrderFulfil": true,
          "IsUnlinked": false,
          "RowId": "8a4155f1-8d34-4031-af0b-1feae379fb3b",
          "OrderId": "a4567145-c5c7-4280-9b7d-64e986274f74",
          "StockItemId": "c10fcc6e-b9f7-4749-a77b-23223b9ab7e5"
        },
        {
        }
      ],
      "HasItems": true,
      "OrderId": "5406d037-9357-4e89-badc-fce1b950f648"
    },
    {
    }
  ]
}