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=[
  "2ecfa53d-f493-49ea-a3d0-02c981456f6b",
  "e03ade9c-254f-4bb2-b8d4-cc490ac5683b"
]

Response

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

[
  {
    "OrderId": "a1346d38-a054-490c-8323-7d167a514422",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2019-06-12T09:27:52.91725+01:00",
    "FulfilmentLocationId": "0070d912-c65c-40f2-8a1d-575f435d538c",
    "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": "05d9c531-4364-440b-bcda-4abcb2d851a0",
          "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-06-12T09:27:52.91725+01:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2019-06-12T09:27:52.91725+01:00",
      "ScheduledDelivery": {
        "From": "2019-06-12T09:27:52.91725+01:00",
        "To": "2019-06-12T09:27:52.91725+01:00"
      },
      "HasScheduledDelivery": true,
      "Location": "8f6f72d2-063f-450b-9877-a72e7b01309e",
      "NumItems": 20,
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "96345fb5-3fcf-4520-b55a-fe231d6c2c92",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.1,
      "ItemWeight": 5.1,
      "PackageCategoryId": "b880c197-dfae-4131-b3da-d6bbab302ccd",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "b1633ae3-b249-4ba2-b3f1-99850c3982b7",
      "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": "0895d0e4-d12d-42d6-b892-09e02de5e209"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 1.1,
      "PostageCost": 2.1,
      "Tax": 3.1,
      "TotalCharge": 4.1,
      "PaymentMethod": "sample string 5",
      "PaymentMethodId": "0d486efe-7ffc-4a2c-a604-01e054aeb403",
      "ProfitMargin": 7.1,
      "TotalDiscount": 8.1,
      "Currency": "sample string 9",
      "CountryTaxRate": 10.1,
      "ConversionRate": 11.1
    },
    "ExtendedProperties": [
      {
        "RowId": "df9a9f26-e804-41e9-aaa3-b63a1d2b3543",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "596d1b8a-8dc4-41b8-ac92-f9fb8817b051",
        "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": "2c6e6e91-ffb1-4380-bb35-d1939bb34a39",
          "Rowid": "2bc5aeb3-3f37-4183-b5c7-9c175c0da6ae",
          "pkPurchaseId": "ccb9cf26-99de-4954-a227-98001df78fa6",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "b39f29f1-7b08-404f-8118-098ea134a271",
          "DateOfDelivery": "2019-06-12T09:27:52.91725+01:00",
          "QuotedDeliveryDate": "2019-06-12T09:27:52.91725+01:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "655dc67b-21fb-469a-89cf-8be042590b7c"
        },
        "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": "634cb1b3-4819-4740-877c-c6094412716e",
        "AdditionalInfo": [
          {
            "pkOptionId": "467d4691-c33a-4c02-b916-fad337bda76d",
            "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": "8f97bcd5-daa7-4b45-9c16-37c44f230c20",
            "BatchId": 1,
            "OrderItemBatchId": 1
          },
          {
          }
        ],
        "InventoryTrackingType": 33,
        "isBatchedStockItem": false,
        "IsWarehouseManaged": true,
        "HasPurchaseOrders": true,
        "CanPurchaseOrderFulfil": true,
        "IsUnlinked": false,
        "RowId": "a321736d-94e4-4a12-bc18-cdeeda6c66e4",
        "OrderId": "e8466428-fc31-4872-b12a-d4352a22685f",
        "StockItemId": "f9a79ed9-b114-4bc6-8f5c-a8891f146635"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "40c90378-2001-422a-b2f9-7765c03bb1f0",
        "OrderId": "a1e13089-3898-43b2-8463-2b1b533d2b14",
        "NoteDate": "2019-06-12T09:27:52.91725+01:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]