Back

Search

Search

Methods

Inventory

Orders

Orders /GetOrdersById

Allows 250 calls per minute

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)

Permissions

GlobalPermissions.OrderBook.ViewOrderDetailsNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Orders/GetOrdersById

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

pkOrderIds=[
  "f5f52222-7abd-4126-8e3a-5471eac8dcde"
]

Response

This is an example of the response JSON. Results will vary depending on your data.

[
  {
    "OrderId": "8cfa5924-0424-436f-9bf7-b4090523799a",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2021-05-05T15:35:25.8897381+01:00",
    "FulfilmentLocationId": "e8c2e578-aa49-4805-99de-e5c596d25e01",
    "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": "8ab541eb-3db9-4037-934f-7ca491636cf6",
          "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-05-05T15:35:25.8897381+01:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2021-05-05T15:35:25.8897381+01:00",
      "ScheduledDelivery": {
        "From": "2021-05-05T15:35:25.8897381+01:00",
        "To": "2021-05-05T15:35:25.8897381+01:00"
      },
      "HasScheduledDelivery": true,
      "Location": "2f363717-aee2-474a-b438-86fc96fd571f",
      "NumItems": 20,
      "PickwaveIds": [
        1
      ],
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "837a6970-ce1f-4c19-b27e-3b2d4135e134",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.0,
      "ItemWeight": 5.0,
      "PackageCategoryId": "a2239060-b054-4014-ac7c-468c6735970b",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "479e91c2-ca7e-43e7-8ade-6dfe7dd6faba",
      "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": "f89e14d7-1722-45ae-bbd2-a4b0921da6a1"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 2.1,
      "PostageCost": 3.1,
      "Tax": 4.1,
      "TotalCharge": 5.1,
      "PaymentMethod": "sample string 6",
      "PaymentMethodId": "52d1136a-7eb6-4ae9-8d5f-ca1406091dae",
      "ProfitMargin": 8.1,
      "TotalDiscount": 9.1,
      "Currency": "sample string 10",
      "CountryTaxRate": 11.1,
      "ConversionRate": 12.1
    },
    "ExtendedProperties": [
      {
        "RowId": "8731219e-2b42-4703-af63-eca0bea7474d",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      }
    ],
    "FolderName": [
      "sample string 1"
    ],
    "Items": [
      {
        "ItemId": "f331f02e-9cd2-46dc-9c63-83820af66478",
        "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": "43897d24-3d6a-41bc-a714-eba77513522d",
          "Rowid": "0613dc71-4b87-41f4-a409-0721d63d19ad",
          "pkPurchaseId": "2440229c-cb78-4438-b84e-5eb838d9a440",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "68e4eeda-5d0b-45c1-8ecd-1519a77fb6e4",
          "DateOfDelivery": "2021-05-05T15:35:25.8897381+01:00",
          "QuotedDeliveryDate": "2021-05-05T15:35:25.8897381+01:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "e75c27f8-bd8d-450c-a91a-ed7929d20296"
        },
        "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": "203a749a-c230-45c8-b114-0a9e3b24d050",
        "AdditionalInfo": [
          {
            "pkOptionId": "5bfbc018-f3c8-4693-89ca-3256667ebfbc",
            "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": "bf548a54-d7b6-48ff-b714-6588b30ca103",
            "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": "dcde1144-c465-418b-873f-d85e6e664226",
            "LogicalDelete": true
          }
        ],
        "RowId": "20a77664-3dcd-4c3a-8b7c-ed1af10bf5e2",
        "OrderId": "3e469d19-f8a2-4df2-a8d9-a7401d71c572",
        "StockItemId": "44dddd31-9e74-40cb-9389-a765a758d849"
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "c2a2b9e4-08da-4507-a7ae-fe81511314b1",
        "OrderId": "f47b28f9-ef4a-4e98-a445-cc2bf7b94892",
        "NoteDate": "2021-05-05T15:35:25.8897381+01:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      }
    ]
  }
]