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

linnworks.core.permissions.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=[
  "22280fc4-c9f4-44e8-a150-1b407ba69e81",
  "0bf6aeb7-b31d-4967-9c2b-03eac2d9f282"
]

Response

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

[
  {
    "OrderId": "f8edfd04-8aaa-4b82-b410-545219fb386b",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2020-11-10T15:13:08.4944138+00:00",
    "FulfilmentLocationId": "cfadf19e-a29d-4b30-8b70-31a727eb2fb3",
    "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": "19c48394-d2f1-4d77-a0c2-1e6a5a1d082d",
          "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": "2020-11-10T15:13:08.4944138+00:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2020-11-10T15:13:08.4944138+00:00",
      "ScheduledDelivery": {
        "From": "2020-11-10T15:13:08.4944138+00:00",
        "To": "2020-11-10T15:13:08.4944138+00:00"
      },
      "HasScheduledDelivery": true,
      "Location": "fefa129d-fec4-4394-abcc-9635baa9e412",
      "NumItems": 20,
      "PickwaveIds": [
        1,
        2
      ],
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "e36213ea-3207-4b4b-8796-130a8b4f7926",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.0,
      "ItemWeight": 5.0,
      "PackageCategoryId": "810edab4-fc43-4ae1-a4de-ec60d99cc01f",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "92607816-af0c-4efe-be11-e22527902e57",
      "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": "c9fd9130-040e-4318-9f7d-ff6c47fb7430"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 2.1,
      "PostageCost": 3.1,
      "Tax": 4.1,
      "TotalCharge": 5.1,
      "PaymentMethod": "sample string 6",
      "PaymentMethodId": "f8cf0029-9e1c-47be-9bba-2199e390cb67",
      "ProfitMargin": 8.1,
      "TotalDiscount": 9.1,
      "Currency": "sample string 10",
      "CountryTaxRate": 11.1,
      "ConversionRate": 12.1
    },
    "ExtendedProperties": [
      {
        "RowId": "4ecd04bc-f2ce-4734-bc88-f3b6b161033c",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "780de9d1-c340-4106-bb75-db628a7aa7c3",
        "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": "2573224f-eb59-483e-a079-f15c1ed1be20",
          "Rowid": "08d12674-282e-4875-a5d9-2d3021cbd5c4",
          "pkPurchaseId": "184245fa-298c-4a03-96d0-4113707bea6a",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "b1496420-ace8-4850-b6d1-2d900aa433eb",
          "DateOfDelivery": "2020-11-10T15:13:08.4944138+00:00",
          "QuotedDeliveryDate": "2020-11-10T15:13:08.4944138+00:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "c831d7cf-c4e5-4a43-8a3f-646412c25f5e"
        },
        "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": "28cfbf2b-240e-4e61-bef0-703777504ade",
        "AdditionalInfo": [
          {
            "pkOptionId": "b284d516-3f09-4c82-8851-3e33c426364b",
            "Property": "sample string 2",
            "Value": "sample string 3"
          },
          {
          }
        ],
        "StockLevelIndicator": 29,
        "ShippingCost": 30.1,
        "PartShippedQty": 31,
        "ItemName": "sample string 32",
        "BatchNumberScanRequired": true,
        "SerialNumberScanRequired": true,
        "BinRack": "sample string 35",
        "BinRacks": [
          {
            "Quantity": 1,
            "BinRack": "sample string 2",
            "Location": "f42eaa57-5578-460f-9286-40f1c80d9f4b",
            "BatchId": 1,
            "OrderItemBatchId": 1
          },
          {
          }
        ],
        "InventoryTrackingType": 36,
        "isBatchedStockItem": false,
        "IsWarehouseManaged": true,
        "HasPurchaseOrders": true,
        "CanPurchaseOrderFulfil": true,
        "IsUnlinked": false,
        "StockItemIntId": 41,
        "Boxes": [
          {
            "BoxId": 1,
            "StockItemIntId": 2,
            "BoxName": "sample string 3",
            "Width": 4.0,
            "Height": 5.0,
            "Length": 6.0,
            "Weight": 7.0,
            "ValuePercentage": 8.0,
            "Barcode": "sample string 9",
            "PackagingTypeId": "ac51d046-6fc9-4583-9f11-b312c79b2dfc"
          },
          {
          }
        ],
        "RowId": "61a314fe-c630-4f2d-961e-32356fc35fcc",
        "OrderId": "e269ebd6-6113-413c-8021-04293e4c8d2a",
        "StockItemId": "af5a18cd-c6f9-4304-8199-aeeb81081876"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "456c5f71-a27e-4abc-9076-27db8d731142",
        "OrderId": "8753bbc4-de3e-4240-a408-254ef77d6bae",
        "NoteDate": "2020-11-10T15:13:08.4944138+00:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]