Back

Search

Search

Methods

Inventory

Orders

Orders /GetOrdersById

Rate Limit: 250/min

Response: List<OrderDetails>



Retrieves the order detail list for a list of order id identifiers (pkOrderId)
For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails

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=[
  "3512a5a7-6b62-4c27-8873-123d40ea1839",
  "69981d67-813e-4f9a-a8c5-a1454d858eaa"
]

Response

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

[
  {
    "OrderId": "5c58e3a7-381f-404c-8958-01c904f139bb",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2021-02-21T11:27:27.4033497+00:00",
    "FulfilmentLocationId": "7fef1fe5-5e34-479a-b935-45cb1150b9df",
    "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": "7a115211-16c4-4255-84e4-c62ec077ad85",
          "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": "2021-02-21T11:27:27.4033497+00:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2021-02-21T11:27:27.4033497+00:00",
      "ScheduledDelivery": {
        "From": "2021-02-21T11:27:27.4033497+00:00",
        "To": "2021-02-21T11:27:27.4033497+00:00"
      },
      "HasScheduledDelivery": true,
      "Location": "8631b2ec-03df-473a-b526-dcb57e1a29b0",
      "NumItems": 20,
      "PickwaveIds": [
        1,
        2
      ],
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "279799f7-f797-4388-ad51-20077b565bd1",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.0,
      "ItemWeight": 5.0,
      "PackageCategoryId": "40b82a3a-5c72-4da3-8126-73a4c1a2a5e3",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "77556ea2-c5ac-4bec-97c1-cebd7a414971",
      "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": "b7f2bbc0-370c-4288-b9cb-d1d92fc0f401"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 2.1,
      "PostageCost": 3.1,
      "Tax": 4.1,
      "TotalCharge": 5.1,
      "PaymentMethod": "sample string 6",
      "PaymentMethodId": "93bf5b79-b62a-4429-bd7e-84070c62032b",
      "ProfitMargin": 8.1,
      "TotalDiscount": 9.1,
      "Currency": "sample string 10",
      "CountryTaxRate": 11.1,
      "ConversionRate": 12.1
    },
    "ExtendedProperties": [
      {
        "RowId": "28c7ac21-5621-4153-9a8f-1ea5ff656c41",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "31935099-bd29-4791-a93f-57297f3de08b",
        "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": "c822e24a-e08c-4603-9937-bcc550dd93ca",
          "Rowid": "9bbc523a-484a-4336-ae45-467006ead623",
          "pkPurchaseId": "9ef6c83f-57a7-4fc8-ab3f-4b2717f88fa8",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "e15e8bdf-7789-4e80-bbe8-ecead7545973",
          "DateOfDelivery": "2021-02-21T11:27:27.4033497+00:00",
          "QuotedDeliveryDate": "2021-02-21T11:27:27.4033497+00:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "e324f133-bfc0-4729-b8ed-de3b97eee59c"
        },
        "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": "6d73f30e-7d20-40e5-a6e2-929181614025",
        "AdditionalInfo": [
          {
            "pkOptionId": "163d912f-6411-4172-a716-a4292e8dff77",
            "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": "76486eca-ae33-4ddd-af1c-1a74a36b87df",
            "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": "0e942824-9b94-4db8-a9e2-e8ad7030e7e4"
          },
          {
          }
        ],
        "RowId": "17b084a9-ddfb-48ac-813e-2a4cc66e6b0d",
        "OrderId": "41bb75e3-8527-4603-8c36-50b87a7520c3",
        "StockItemId": "a54026bf-c837-414f-8c31-05f31208fb0c"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "3d7eb26b-f534-4aa6-8291-49ee3e87b115",
        "OrderId": "82d95330-d39c-4814-847b-63f653a5d672",
        "NoteDate": "2021-02-21T11:27:27.4033497+00:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]