Back

Search

Search

Methods

Inventory

Orders

Orders /GetOrdersById

Response: List<OrderDetails>



Retrieves the order detail list for a list of order id identifiers (pkOrderId)

Parameters

NameTypeDescription
pkOrderIdsList<Guid>List of order ids (pkOrderId)

HTTP Endpoint

Server /Orders / GetOrdersById

Permissions

GlobalPermissions.OrderBook.ViewOrderDetailsNode

Example Code

Example Request

The following request format is required for this method.

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

pkOrderIds=[
  "2e29a379-a6ce-41aa-9084-b07aa4dafcf9",
  "48fe4b2b-cc33-4bc6-93ab-4dde17c3b43f"
]

Response

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

[
  {
    "OrderId": "f5613f2a-9727-47bd-b873-ef5a3e54d23b",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2019-10-09T15:11:45.2215222+01:00",
    "FulfilmentLocationId": "491eb9b0-4521-46d0-bb08-a4a740e75a1b",
    "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": "79b884fe-c955-4da9-bf92-d700dd619230",
          "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-10-09T15:11:45.2215222+01:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2019-10-09T15:11:45.2215222+01:00",
      "ScheduledDelivery": {
        "From": "2019-10-09T15:11:45.2215222+01:00",
        "To": "2019-10-09T15:11:45.2215222+01:00"
      },
      "HasScheduledDelivery": true,
      "Location": "f5753993-b800-4c7f-9974-954ef4bdc6f2",
      "NumItems": 20,
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "1f3a04ae-9f74-4f1e-bf53-b0709debdb8a",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.1,
      "ItemWeight": 5.1,
      "PackageCategoryId": "0a5e48c1-d06a-455d-970f-72d0781a01be",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "cef71d81-685f-4e09-851c-476e73241a75",
      "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": "a43bf877-2835-4c5f-acf2-614abe65a540"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 1.1,
      "PostageCost": 2.1,
      "Tax": 3.1,
      "TotalCharge": 4.1,
      "PaymentMethod": "sample string 5",
      "PaymentMethodId": "9b66da38-4ca9-42d0-b71b-b0640eff3355",
      "ProfitMargin": 7.1,
      "TotalDiscount": 8.1,
      "Currency": "sample string 9",
      "CountryTaxRate": 10.1,
      "ConversionRate": 11.1
    },
    "ExtendedProperties": [
      {
        "RowId": "a43a9acd-6455-40ca-be20-704cca0534b2",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "66078a70-9dd3-4976-a26a-103569509f4e",
        "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": "d7c7b093-b0da-4dd0-9cb1-59a6a68092b7",
          "Rowid": "30df9a0f-91fb-4fd2-8f60-c5fe65c1d635",
          "pkPurchaseId": "e54dc1ea-569b-47b5-8f03-a239ae76d26d",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "571d056d-4550-480a-a950-4049ddc42112",
          "DateOfDelivery": "2019-10-09T15:11:45.2215222+01:00",
          "QuotedDeliveryDate": "2019-10-09T15:11:45.2215222+01:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "086edc95-996f-4ce7-9d14-e4ea1a0f3012"
        },
        "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": "6728f92f-52f7-46d7-8533-b05193497b7b",
        "AdditionalInfo": [
          {
            "pkOptionId": "35a1cb61-f810-45da-9a26-4cd623dfbc02",
            "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": "4fbcf164-6b6f-4562-bd7a-0111446d9cad",
            "BatchId": 1,
            "OrderItemBatchId": 1
          },
          {
          }
        ],
        "InventoryTrackingType": 33,
        "isBatchedStockItem": false,
        "IsWarehouseManaged": true,
        "HasPurchaseOrders": true,
        "CanPurchaseOrderFulfil": true,
        "IsUnlinked": false,
        "RowId": "28bb2987-6ae7-4c3c-8cd9-c1770076c86a",
        "OrderId": "59f7cc10-9ce3-4639-a108-93c40c02b7c3",
        "StockItemId": "45a7c83c-9e61-4ffd-a059-41167c33f0ee"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "7078baa1-6826-47fd-8295-0dba0758fad5",
        "OrderId": "511e507b-4971-4664-b21a-885ef0e87e42",
        "NoteDate": "2019-10-09T15:11:45.2215222+01:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]