Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

Orders /GetOrderById

Allows 150 calls per minute

Response: OrderDetails



Retrieves the order detail for a unique system order id identifier (pkOrderId)
For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails

Parameters

NameTypeDescription
pkOrderIdGuidpkOrderId

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/GetOrderById

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.

pkOrderId=86c97c6a-daa4-461a-9c7e-95632edf05ea

Response

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

{
  "OrderId": "d501be4b-9a81-4f67-ba2d-f16f71b30ae5",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2022-03-09T13:04:14.2056784+00:00",
  "FulfilmentLocationId": "e9f98161-1128-47af-9453-008716dc3e2e",
  "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": "598e51df-8007-4752-a8f5-a1b6a39cd21f",
        "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": "2022-03-09T13:04:14.2066761+00:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2022-03-09T13:04:14.2066761+00:00",
    "ScheduledDelivery": {
      "From": "2022-03-09T13:04:14.2066761+00:00",
      "To": "2022-03-09T13:04:14.2066761+00:00"
    },
    "HasScheduledDelivery": true,
    "Location": "604a4cb3-ab12-4a28-b6bc-4dd59f50748c",
    "NumItems": 20,
    "PickwaveIds": [
      1
    ],
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "1131629b-d29c-4c2a-9f06-fdb1106be0d5",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.0,
    "ItemWeight": 5.0,
    "PackageCategoryId": "6bd6a2a9-f329-4e86-ab7a-c3e4420e5bf6",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "bf042006-8d96-4e1c-b4ac-c6d7a378e18e",
    "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": "4ad46916-cf0a-44d6-98f8-183f59c0a1bf"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 2.1,
    "PostageCost": 3.1,
    "PostageCostExTax": 4.1,
    "Tax": 5.1,
    "TotalCharge": 6.1,
    "PaymentMethod": "sample string 7",
    "PaymentMethodId": "1324f260-98ef-4088-a911-47d90ebed85e",
    "ProfitMargin": 9.1,
    "TotalDiscount": 10.1,
    "Currency": "sample string 11",
    "CountryTaxRate": 12.1,
    "ConversionRate": 13.1
  },
  "ExtendedProperties": [
    {
      "RowId": "1e9d3743-2ba0-4974-bd5e-b8742f41cb8c",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "FolderName": [
    "sample string 1"
  ],
  "Items": [
    {
      "ItemId": "d6d97109-a207-4d19-ba43-cbe61995b80c",
      "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": "7de9aeef-294b-4bfb-b553-fd078111c60a",
        "Rowid": "ae7f11ca-2721-4b8d-b99f-af0a8e2bf05a",
        "pkPurchaseId": "981b9ad1-82fe-42f8-be92-d1c9a8507072",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "cc9c5021-1b94-427f-8e01-05b7e63e73ed",
        "DateOfDelivery": "2022-03-09T13:04:14.2066761+00:00",
        "QuotedDeliveryDate": "2022-03-09T13:04:14.2066761+00:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "0685ba49-b50e-45e6-a0b8-a3d0b51e090d"
      },
      "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": "8c68ffcc-971f-4b65-b899-9e0314d1b83a",
      "AdditionalInfo": [
        {
          "pkOptionId": "b53f310b-7957-4761-ac38-15bf35161dd6",
          "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": "83f489af-5786-4b00-815a-f6d1d8f4692a",
          "BatchId": 1,
          "OrderItemBatchId": 1
        }
      ],
      "InventoryTrackingType": 36,
      "isBatchedStockItem": false,
      "IsWarehouseManaged": true,
      "IsUnlinked": false,
      "StockItemIntId": 39,
      "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": "b632ad32-8e6d-4e9e-a74f-cd24725b16a4",
          "LogicalDelete": true
        }
      ],
      "RowId": "3dae56d2-c7ea-4c60-a964-ceae55b9a70b",
      "OrderId": "60182ebe-39b3-423e-ba29-e7eb6e1d3e9c",
      "StockItemId": "b0c4e8a1-a168-4d68-94aa-c8d04b43ced5"
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "f934a400-11d3-46c4-88d6-11bd46eae624",
      "OrderId": "b458c035-bdf2-4bf0-a967-c24a3e33ab47",
      "NoteDate": "2022-03-09T13:04:14.2066761+00:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    }
  ],
  "PaidDateTime": "2022-03-09T13:04:14.2066761+00:00",
  "TaxId": "sample string 5"
}