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=[
  "70b76fd2-cc65-4b84-8f33-1a45d53bd0a3",
  "a669e26a-5464-4c4d-ae40-9c40c3625629"
]

Response

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

[
  {
    "OrderId": "5cfa0f58-a019-4987-98b9-a9b18adb7bfa",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2018-10-03T11:12:36.4648938+01:00",
    "FulfilmentLocationId": "4b4ff9e6-5207-4517-bb99-cb3ca643ff55",
    "GeneralInfo": {
      "Status": 1,
      "LabelPrinted": true,
      "LabelError": "sample string 3",
      "InvoicePrinted": true,
      "PickListPrinted": true,
      "IsRuleRun": true,
      "Notes": 7,
      "PartShipped": true,
      "Marker": 64,
      "IsParked": true,
      "Identifiers": null,
      "ReferenceNum": "sample string 10",
      "SecondaryReference": "sample string 11",
      "ExternalReferenceNum": "sample string 12",
      "ReceivedDate": "2018-10-03T11:12:36.4648938+01:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2018-10-03T11:12:36.4648938+01:00",
      "ScheduledDelivery": {
        "From": "2018-10-03T11:12:36.4648938+01:00",
        "To": "2018-10-03T11:12:36.4648938+01:00"
      },
      "HasScheduledDelivery": true,
      "Location": "b47ebaed-61f3-4fd7-b05a-a272c7439312",
      "NumItems": 20,
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "e48492ee-b48d-415e-b9d1-9b5560624053",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.1,
      "ItemWeight": 5.1,
      "PackageCategoryId": "a0f94fb9-1cb6-49a5-99ca-5cc0df678b5a",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "8e9adb95-92be-4d67-ad9f-5ddd6fd73707",
      "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": "8e9889d1-ab3b-48fb-91bc-8d8af5cf732f"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 1.1,
      "PostageCost": 2.1,
      "Tax": 3.1,
      "TotalCharge": 4.1,
      "PaymentMethod": "sample string 5",
      "PaymentMethodId": "5dc91e7d-07f9-426b-b61e-95398966a76e",
      "ProfitMargin": 7.1,
      "TotalDiscount": 8.1,
      "Currency": "sample string 9",
      "CountryTaxRate": 10.1,
      "ConversionRate": 11.1
    },
    "ExtendedProperties": [
      {
        "RowId": "94fb3151-9968-4886-bf24-890814a5bc57",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "d9a5f9d1-53ec-4e24-9582-34e3cada33cf",
        "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,
        "InOrderBook": 1,
        "Level": 11,
        "MinimumLevel": 1,
        "AvailableStock": 12,
        "PricePerUnit": 13.1,
        "UnitCost": 14.1,
        "Discount": 15.1,
        "Tax": 20.1,
        "TaxRate": 16.1,
        "Cost": 17.1,
        "CostIncTax": 18.1,
        "CompositeSubItems": [
          {
          },
          {
          }
        ],
        "IsService": true,
        "SalesTax": 20.1,
        "TaxCostInclusive": true,
        "PartShipped": true,
        "Weight": 23.1,
        "BarcodeNumber": "sample string 24",
        "Market": 25,
        "ChannelSKU": "sample string 26",
        "ChannelTitle": "sample string 27",
        "DiscountValue": 10.222739018087856,
        "HasImage": true,
        "ImageId": "37780c69-8f05-4317-9984-6e07051e4e97",
        "AdditionalInfo": [
          {
            "pkOptionId": "e77145d7-98c8-4f26-a5b2-c481d858d3ee",
            "Property": "sample string 2",
            "Value": "sample string 3"
          },
          {
          }
        ],
        "StockLevelIndicator": 28,
        "BatchNumberScanRequired": true,
        "SerialNumberScanRequired": true,
        "BinRack": "sample string 31",
        "BinRacks": [
          {
            "Quantity": 1,
            "BinRack": "sample string 2",
            "Location": "5a766624-eb37-4683-92b1-e58fd27725b4",
            "BatchId": 1,
            "OrderItemBatchId": 1
          },
          {
          }
        ],
        "InventoryTrackingType": 32,
        "isBatchedStockItem": false,
        "HasPurchaseOrders": true,
        "CanPurchaseOrderFulfil": true,
        "IsUnlinked": false,
        "RowId": "f9e889d3-9dce-4858-9ccd-85da6f38eaee",
        "OrderId": "8576cd11-20d0-4eb9-bc4e-acd616e93139",
        "StockItemId": "7c1a6611-9a3a-44cc-830f-7835a257ec2c"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "ac924d48-0be8-42af-b8e1-e822bfc19931",
        "OrderId": "81574b6f-2c4b-4965-bdf4-18fbe522f667",
        "NoteDate": "2018-10-03T11:12:36.4648938+01:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]