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.
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=dc9eb0c5-32dc-4652-8f5a-9a19a285cfb0This is an example of the response JSON. Results will vary depending on your data.
{
"OrderId": "2dcae707-563d-44e0-9b3b-a5836f76a636",
"NumOrderId": 2,
"Processed": true,
"ProcessedDateTime": "2021-07-29T09:24:51.9154492+01:00",
"FulfilmentLocationId": "1b806048-e28c-4dde-9c0e-446fb8e114f7",
"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": "e36b47fe-39ac-4826-a012-29fa1b6d28c7",
"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-07-29T09:24:51.9154492+01:00",
"Source": "sample string 14",
"SubSource": "sample string 15",
"SiteCode": "sample string 16",
"HoldOrCancel": true,
"DespatchByDate": "2021-07-29T09:24:51.9154492+01:00",
"ScheduledDelivery": {
"From": "2021-07-29T09:24:51.9154492+01:00",
"To": "2021-07-29T09:24:51.9154492+01:00"
},
"HasScheduledDelivery": true,
"Location": "465b13e1-e2e2-4434-96ac-3bfb0fc73b60",
"NumItems": 20,
"PickwaveIds": [
1
],
"StockAllocationType": 0
},
"ShippingInfo": {
"Vendor": "sample string 1",
"PostalServiceId": "fb9378f2-822a-4eb4-9345-fc8e1125ddc5",
"PostalServiceName": "sample string 3",
"TotalWeight": 4.0,
"ItemWeight": 5.0,
"PackageCategoryId": "8fd105b9-afc1-48ec-adf0-05dd2ee032bc",
"PackageCategory": "sample string 7",
"PackageTypeId": "e319619c-fddf-4901-9c67-dcb9c4298bc5",
"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": "7be9ffa7-16a5-416b-ba84-e0fdde09e7aa"
},
"BillingAddress": {
}
},
"TotalsInfo": {
"Subtotal": 2.1,
"PostageCost": 3.1,
"Tax": 4.1,
"TotalCharge": 5.1,
"PaymentMethod": "sample string 6",
"PaymentMethodId": "24e6cde6-229d-4aeb-8ab8-9a9675532b9b",
"ProfitMargin": 8.1,
"TotalDiscount": 9.1,
"Currency": "sample string 10",
"CountryTaxRate": 11.1,
"ConversionRate": 12.1
},
"ExtendedProperties": [
{
"RowId": "6bc8f756-4249-44e0-aa26-9839ca6ca527",
"Name": "sample string 2",
"Value": "sample string 3",
"Type": "sample string 4"
}
],
"FolderName": [
"sample string 1"
],
"Items": [
{
"ItemId": "d289642e-2aa5-4a05-9f4c-4c2d3d0fe35a",
"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": "b6dfa2cd-e8a4-4eae-854c-cde8f707509d",
"Rowid": "163efdea-910b-4ac3-90f5-fe8ec122c0f4",
"pkPurchaseId": "b35d38c6-6f35-444f-b65c-c751e3f6c325",
"ExternalInvoiceNumber": "sample string 4",
"fkSupplierId": "f390a932-5175-4a82-bbce-421b84c1be76",
"DateOfDelivery": "2021-07-29T09:24:51.9154492+01:00",
"QuotedDeliveryDate": "2021-07-29T09:24:51.9154492+01:00",
"SupplierName": "sample string 8",
"fkLocationId": "fe82b627-ed66-4f94-b78d-41445de79d0c"
},
"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": "ed4bc036-2533-4420-be9f-05a4fc059364",
"AdditionalInfo": [
{
"pkOptionId": "2bb82b40-f1b6-47f3-9ce9-f56402949037",
"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": "7964a1ed-fe81-4554-b9b1-b7acf4d6a18a",
"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": "2ab679dc-265b-4ced-87e5-d0c3d25ebd77",
"LogicalDelete": true
}
],
"RowId": "69a707de-551c-48ab-8672-5507da4c4575",
"OrderId": "293a0fca-00ad-4cb6-86f0-d65468618212",
"StockItemId": "f3175391-9d17-493f-953b-dcd78e69b79b"
}
],
"Notes": [
{
"OrderNoteId": "ba7604e5-79cb-463d-aa25-0929d05240fd",
"OrderId": "3208ce13-4058-4e37-863a-57950306c88a",
"NoteDate": "2021-07-29T09:24:51.9154492+01:00",
"Internal": true,
"Note": "sample string 5",
"CreatedBy": "sample string 6",
"NoteTypeId": 64
}
],
"PaidDateTime": "2021-07-29T09:24:51.9154492+01:00"
}