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.ViewOrderDetails.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=[
  "4ffa90d5-0c2c-4152-9264-52fed83e7465",
  "a967d510-218c-42d9-bc91-f2f4f6c8d51f"
]

Response

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

[
  {
    "OrderId": "8f322a8f-ccb7-4ca0-af32-9502a4ef476d",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2018-02-19T16:57:08.4511838+00:00",
    "FulfilmentLocationId": "c33173f5-4165-4aaf-aae3-69eb95e989d0",
    "GeneralInfo": {
      "Status": 1,
      "LabelPrinted": true,
      "LabelError": "sample string 3",
      "InvoicePrinted": true,
      "PickListPrinted": true,
      "IsRuleRun": true,
      "Notes": 7,
      "PartShipped": true,
      "Marker": 64,
      "ReferenceNum": "sample string 9",
      "SecondaryReference": "sample string 10",
      "ExternalReferenceNum": "sample string 11",
      "ReceivedDate": "2018-02-19T16:57:08.4511838+00:00",
      "Source": "sample string 13",
      "SubSource": "sample string 14",
      "SiteCode": "sample string 15",
      "HoldOrCancel": true,
      "DespatchByDate": "2018-02-19T16:57:08.4511838+00:00",
      "Location": "7c0afcda-6942-4df8-b1e8-df564c435e28",
      "NumItems": 19
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "7b305971-5764-4550-8617-426cebae944a",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.1,
      "ItemWeight": 5.1,
      "PackageCategoryId": "57ea8ab5-9e7a-44f4-9091-67f870e5658e",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "c61997f2-b916-4b5f-8977-1fe920ec8b8a",
      "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",
        "FullName": "sample string 9",
        "Company": "sample string 10",
        "PhoneNumber": "sample string 11",
        "CountryId": "11b9b073-8717-42b8-9b3d-bba861b6f520"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 1.1,
      "PostageCost": 2.1,
      "Tax": 3.1,
      "TotalCharge": 4.1,
      "PaymentMethod": "sample string 5",
      "PaymentMethodId": "4960b5d3-9bb6-445e-a467-ae21244297e1",
      "ProfitMargin": 7.1,
      "TotalDiscount": 8.1,
      "Currency": "sample string 9",
      "CountryTaxRate": 10.1,
      "ConversionRate": 11.1
    },
    "ExtendedProperties": [
      {
        "RowId": "bd6456de-c9c2-4699-b124-dde78780f0b3",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "OrderId": "865d04d3-0698-4d9f-93eb-cf881bc492c3",
        "ItemId": "25e7d9de-f8a5-460d-9a3a-03d2469cafaa",
        "StockItemId": "4694545d-a703-4779-84c8-c1362eac5a5b",
        "ItemNumber": "sample string 4",
        "SKU": "sample string 5",
        "ItemSource": "sample string 6",
        "Title": "sample string 7",
        "Quantity": 8,
        "CategoryName": "sample string 9",
        "CompositeAvailablity": 1,
        "RowId": "1888c5fd-369c-4830-ad54-bf4715a7fbd1",
        "StockLevelsSpecified": true,
        "OnOrder": 12,
        "InOrderBook": 1,
        "Level": 13,
        "MinimumLevel": 1,
        "AvailableStock": 14,
        "PricePerUnit": 15.1,
        "UnitCost": 16.1,
        "Discount": 17.1,
        "Tax": 22.1,
        "TaxRate": 18.1,
        "Cost": 19.1,
        "CostIncTax": 20.1,
        "CompositeSubItems": [
          {
          },
          {
          }
        ],
        "IsService": true,
        "SalesTax": 22.1,
        "TaxCostInclusive": true,
        "PartShipped": true,
        "Weight": 25.1,
        "BarcodeNumber": "sample string 26",
        "Market": 27,
        "ChannelSKU": "sample string 28",
        "ChannelTitle": "sample string 29",
        "DiscountValue": 17.490939881456391,
        "HasImage": true,
        "ImageId": "0bd9b3b1-23a0-4fd9-827f-aff900a482f3",
        "AdditionalInfo": [
          {
            "pkOptionId": "53160a9b-b90f-42e2-bad3-265e98c28b2a",
            "Property": "sample string 2",
            "Value": "sample string 3"
          },
          {
          }
        ],
        "StockLevelIndicator": 30,
        "BatchNumberScanRequired": true,
        "SerialNumberScanRequired": true,
        "BinRack": "sample string 33",
        "BinRacks": [
          {
            "Quantity": 1,
            "BinRack": "sample string 2",
            "Location": "658cdd15-e37f-406c-a7af-722c6f23d27c"
          },
          {
          }
        ],
        "InventoryTrackingType": 34,
        "isBatchedStockItem": false
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "6615bf13-7426-4b04-81d2-9e4085eee353",
        "OrderId": "1c3b452d-3721-4fcc-b26b-14fe60ed6e10",
        "NoteDate": "2018-02-19T16:57:08.4511838+00:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]