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=[
  "469dd805-e837-43c3-9c1b-e8fda4c7a291",
  "bbec372a-6321-4cce-b4c1-186c3472ead6"
]

Response

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

[
  {
    "OrderId": "50c467b9-8655-495d-ab1a-83626688e1e4",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2019-08-21T13:34:06.5230619+01:00",
    "FulfilmentLocationId": "7a55acc8-0e09-4a5f-b678-7ffb54885b39",
    "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": "fe6a4da1-5cb4-40cc-b4ba-4af8994dfa00",
          "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-08-21T13:34:06.5230619+01:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2019-08-21T13:34:06.5230619+01:00",
      "ScheduledDelivery": {
        "From": "2019-08-21T13:34:06.5230619+01:00",
        "To": "2019-08-21T13:34:06.5230619+01:00"
      },
      "HasScheduledDelivery": true,
      "Location": "9c649801-26b1-43b3-93e9-6fb805eefd7b",
      "NumItems": 20,
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "34ecd23d-f6c6-41fe-aaa8-b5b8ebdbfcf3",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.1,
      "ItemWeight": 5.1,
      "PackageCategoryId": "af432c91-63e6-41b0-bec4-2a0fbeef4567",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "5bb05ad9-82cb-48de-b704-be584e4dc518",
      "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": "b78f562f-63cd-4685-b996-70f45561e0bd"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 1.1,
      "PostageCost": 2.1,
      "Tax": 3.1,
      "TotalCharge": 4.1,
      "PaymentMethod": "sample string 5",
      "PaymentMethodId": "4f818bde-d360-482b-b5ab-fd7453ffc462",
      "ProfitMargin": 7.1,
      "TotalDiscount": 8.1,
      "Currency": "sample string 9",
      "CountryTaxRate": 10.1,
      "ConversionRate": 11.1
    },
    "ExtendedProperties": [
      {
        "RowId": "7687d57f-1f6c-423d-ae7e-63dd102d38ef",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "4a1b8771-1fd8-4434-9e06-b304be7f9f92",
        "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": "ed89711d-521f-41c5-ac2e-71654bead387",
          "Rowid": "b9469f40-99e0-424e-bdbf-d81821958e12",
          "pkPurchaseId": "f79a700a-ee22-449d-b2e7-7efdfea1bb53",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "3391d78f-31c7-4bd1-b028-a4a79b01002d",
          "DateOfDelivery": "2019-08-21T13:34:06.5230619+01:00",
          "QuotedDeliveryDate": "2019-08-21T13:34:06.5230619+01:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "c8b3bcf3-ca50-4802-acb5-d9a0953aeb6c"
        },
        "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": "338bc3af-2e67-4def-bc86-0c1115ac2d35",
        "AdditionalInfo": [
          {
            "pkOptionId": "b06c674f-33ad-4d49-a695-34fd1c39e20d",
            "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": "8c0c28d5-ff54-4db5-ac70-757d1a3684a6",
            "BatchId": 1,
            "OrderItemBatchId": 1
          },
          {
          }
        ],
        "InventoryTrackingType": 33,
        "isBatchedStockItem": false,
        "IsWarehouseManaged": true,
        "HasPurchaseOrders": true,
        "CanPurchaseOrderFulfil": true,
        "IsUnlinked": false,
        "RowId": "5b5dbcca-1dbf-4473-ae53-f52c54e6a6e6",
        "OrderId": "822aba5d-47b7-4953-a953-b5906b638c98",
        "StockItemId": "e15b848a-6185-42ff-9096-eb20dd85b791"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "d888d767-e8c2-46a8-a518-74cd10aaa596",
        "OrderId": "f1e18158-82e3-4fd5-9bf7-c533671b864b",
        "NoteDate": "2019-08-21T13:34:06.5230619+01:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]