Retrieves the order detail for a unique system order id identifier (pkOrderId)
For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails
| Name | Type | Description |
|---|---|---|
| pkOrderId | Guid | pkOrderId |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/Orders/GetOrderByIdConnection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE
This is an example of the request structure. Results will vary depending on your data.
pkOrderId=3f5e9b9a-3f39-443f-a0b6-e6c3c17f8438This is an example of the response JSON. Results will vary depending on your data.
{
"OrderId": "3111a0e8-dd14-4c25-9496-5f81a2093914",
"NumOrderId": 2,
"Processed": true,
"ProcessedDateTime": "2023-01-10T13:49:54.4955163+00:00",
"FulfilmentLocationId": "b9581d63-11e0-48b5-8854-38b496c95804",
"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": "40dc028e-82cd-43af-8c5b-4fa7bb7d10fe",
"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": "2023-01-10T13:49:54.4955163+00:00",
"Source": "sample string 14",
"SubSource": "sample string 15",
"SiteCode": "sample string 16",
"HoldOrCancel": true,
"DespatchByDate": "2023-01-10T13:49:54.4955163+00:00",
"ScheduledDelivery": {
"From": "2023-01-10T13:49:54.4955163+00:00",
"To": "2023-01-10T13:49:54.4955163+00:00"
},
"HasScheduledDelivery": true,
"Location": "1e1deb03-ab4a-41f9-8b0d-cf791e961860",
"NumItems": 20,
"PickwaveIds": [
1
],
"StockAllocationType": 0
},
"ShippingInfo": {
"Vendor": "sample string 1",
"PostalServiceId": "a75ddfe6-69a8-496d-b3b4-729482fe7380",
"PostalServiceName": "sample string 3",
"TotalWeight": 4.0,
"ItemWeight": 5.0,
"PackageCategoryId": "f79a407f-62f7-4440-b4b6-87ba79993034",
"PackageCategory": "sample string 7",
"PackageTypeId": "aa1453fe-3d81-4174-904c-11b5257df6e2",
"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": "e70a57e1-785d-4b29-92b2-8859f1189d76"
},
"BillingAddress": {
}
},
"TotalsInfo": {
"Subtotal": 2.1,
"PostageCost": 3.1,
"PostageCostExTax": 4.1,
"Tax": 5.1,
"TotalCharge": 6.1,
"PaymentMethod": "sample string 7",
"PaymentMethodId": "de5896de-c8a3-4fde-a11b-2ffee292f352",
"ProfitMargin": 9.1,
"TotalDiscount": 10.1,
"Currency": "sample string 11",
"CountryTaxRate": 12.1,
"ConversionRate": 13.1
},
"ExtendedProperties": [
{
"RowId": "429d715f-f704-4082-b5b9-d8aa3c3a4bab",
"Name": "sample string 2",
"Value": "sample string 3",
"Type": "sample string 4"
}
],
"FolderName": [
"sample string 1"
],
"Items": [
{
"ItemId": "dd27efbb-88f4-497c-aa30-201113be9712",
"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": "72f92e5e-8452-4df5-9342-c57d4385d71b",
"Rowid": "23b396b3-0d0d-42e4-8b76-4daa6ad9cdf8",
"pkPurchaseId": "9fa8275e-c8f5-495c-acdd-9df5eab35349",
"ExternalInvoiceNumber": "sample string 4",
"fkSupplierId": "c1e8c099-0621-47d3-9926-16ea63034f27",
"DateOfDelivery": "2023-01-10T13:49:54.4955163+00:00",
"QuotedDeliveryDate": "2023-01-10T13:49:54.4955163+00:00",
"SupplierName": "sample string 8",
"fkLocationId": "e444ac31-bd8f-4dcd-9434-a78b6fd47135"
},
"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": "f9ffec2b-825d-4d76-ac11-065c3943592e",
"AdditionalInfo": [
{
"pkOptionId": "31e57e45-7846-4ddd-a2a4-57a3b53ef7fa",
"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": "11039fcf-bad4-4de1-b3a3-603994aacb5c",
"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": "ed11388b-614a-4574-bce0-630e3205b7ac",
"LogicalDelete": true
}
],
"RowId": "7d60abad-dcbd-4f00-a6f3-e1111d00275f",
"OrderId": "2b2dffbc-59df-4366-ba68-9f3a97b5e733",
"StockItemId": "ef53d78c-d161-4eb4-abec-0b5126845fc9"
}
],
"Notes": [
{
"OrderNoteId": "d5e9c775-b0c2-4046-8a8f-b4570b934f8e",
"OrderId": "229675e4-ac7c-4e65-9d2e-d4a30d1cf568",
"NoteDate": "2023-01-10T13:49:54.4965308+00:00",
"Internal": true,
"Note": "sample string 5",
"CreatedBy": "sample string 6",
"NoteTypeId": 64
}
],
"PaidDateTime": "2023-01-10T13:49:54.4965308+00:00",
"TaxId": "sample string 5"
}