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=[
  "cb4c72a1-31c3-45ac-a7e1-4be6c94a6e72",
  "9590ae66-7747-4c41-82c1-d1a8ed9b5311"
]

Response

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

[
  {
    "OrderId": "662cdee7-7ddc-426e-b0e4-7583a5fec3ff",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2019-11-28T09:46:01.618499+00:00",
    "FulfilmentLocationId": "861aa3d4-c4ea-4cc5-a8d9-0368b3ff5a87",
    "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": "5fe80e9c-4aba-4414-a8ad-34d2da02832e",
          "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-11-28T09:46:01.618499+00:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2019-11-28T09:46:01.618499+00:00",
      "ScheduledDelivery": {
        "From": "2019-11-28T09:46:01.618499+00:00",
        "To": "2019-11-28T09:46:01.618499+00:00"
      },
      "HasScheduledDelivery": true,
      "Location": "6410bfed-ab29-4c4e-ae57-fbb39108e9d4",
      "NumItems": 20,
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "393bbb12-19ef-4957-ad28-b57997761eab",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.1,
      "ItemWeight": 5.1,
      "PackageCategoryId": "e703ba01-47ec-4552-b502-319c0acaf124",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "163b590b-cfc0-4524-b4cf-b8138e605980",
      "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": "8880980e-b1d7-4361-b760-69d0b4f2fcfb"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 1.1,
      "PostageCost": 2.1,
      "Tax": 3.1,
      "TotalCharge": 4.1,
      "PaymentMethod": "sample string 5",
      "PaymentMethodId": "edd17581-de98-4950-9a18-9f5d8133d78f",
      "ProfitMargin": 7.1,
      "TotalDiscount": 8.1,
      "Currency": "sample string 9",
      "CountryTaxRate": 10.1,
      "ConversionRate": 11.1
    },
    "ExtendedProperties": [
      {
        "RowId": "5a85d935-25eb-4719-904c-fd1ef5a1263e",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "ee69d96b-4b4d-4af7-aa8f-975a59c95726",
        "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": "1e0b429e-1e7b-4b2f-acd2-d7bbf9b95134",
          "Rowid": "9c5be06c-9729-4444-9a0d-cc7e3a27e008",
          "pkPurchaseId": "8d48025f-a49c-4570-8a1a-039cb89cef2c",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "827cc194-4e9a-4f50-a7b4-d58f06e7cf07",
          "DateOfDelivery": "2019-11-28T09:46:01.618499+00:00",
          "QuotedDeliveryDate": "2019-11-28T09:46:01.618499+00:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "d88752a5-520f-4a56-9268-bf56c5a437eb"
        },
        "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": "48906137-781e-4a34-94fc-3f0d003461fd",
        "AdditionalInfo": [
          {
            "pkOptionId": "e2b655b8-7312-4021-9299-e45741cd5d02",
            "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": "af43a8fb-dd86-45e1-a000-6bdf6df757a1",
            "BatchId": 1,
            "OrderItemBatchId": 1
          },
          {
          }
        ],
        "InventoryTrackingType": 33,
        "isBatchedStockItem": false,
        "IsWarehouseManaged": true,
        "HasPurchaseOrders": true,
        "CanPurchaseOrderFulfil": true,
        "IsUnlinked": false,
        "RowId": "9b2cee79-2824-4341-ba96-b0ffce22df51",
        "OrderId": "4b1a79c6-8953-4309-8623-8da498ab48c7",
        "StockItemId": "203387cb-6039-4f48-b544-ff30d2af2ce8"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "ef32a54e-5a20-49b3-b7e9-5ab954dccb3f",
        "OrderId": "bda9ba1a-85c0-4897-b55b-1f083b4667b1",
        "NoteDate": "2019-11-28T09:46:01.618499+00:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]