Retrieves the order detail for a unique system order id identifier (pkOrderId)
| Name | Type | Description |
|---|---|---|
| pkOrderId | Guid | pkOrderId |
The following request format is required for this method.
POST https://eu-ext.linnworks.net//api/Orders/GetOrderById 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
pkOrderId=af6c7b68-ed5b-4bd5-9e78-ee086a2fabe6
This is an example response. Results may vary depending on your data.
{
"OrderId": "8e00bd60-1374-4979-b0ce-6ce2bdd45653",
"NumOrderId": 2,
"Processed": true,
"ProcessedDateTime": "2019-11-28T09:46:01.5666966+00:00",
"FulfilmentLocationId": "ca49cef7-362a-4832-9bdf-5ac02703fe57",
"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": "41fc1e6f-e80b-4bd6-80c9-4b96328d4bb5",
"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-11-28T09:46:01.5666966+00:00",
"Source": "sample string 14",
"SubSource": "sample string 15",
"SiteCode": "sample string 16",
"HoldOrCancel": true,
"DespatchByDate": "2019-11-28T09:46:01.5666966+00:00",
"ScheduledDelivery": {
"From": "2019-11-28T09:46:01.5666966+00:00",
"To": "2019-11-28T09:46:01.5666966+00:00"
},
"HasScheduledDelivery": true,
"Location": "e7f61df5-ff71-4e08-a30b-af65a40700b9",
"NumItems": 20,
"StockAllocationType": 0
},
"ShippingInfo": {
"Vendor": "sample string 1",
"PostalServiceId": "fe9ba454-06d9-49ea-888f-16dd5e9b2b3d",
"PostalServiceName": "sample string 3",
"TotalWeight": 4.1,
"ItemWeight": 5.1,
"PackageCategoryId": "af7e61df-4586-4c06-a72e-d101e90b8ee6",
"PackageCategory": "sample string 7",
"PackageTypeId": "86076bb6-ef8d-4828-9bd2-66af05b9775c",
"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": "73a741c7-1638-444e-8412-a1794113f191"
},
"BillingAddress": {
}
},
"TotalsInfo": {
"Subtotal": 1.1,
"PostageCost": 2.1,
"Tax": 3.1,
"TotalCharge": 4.1,
"PaymentMethod": "sample string 5",
"PaymentMethodId": "207cd786-c2e8-439d-98c6-ce4cb5be88a9",
"ProfitMargin": 7.1,
"TotalDiscount": 8.1,
"Currency": "sample string 9",
"CountryTaxRate": 10.1,
"ConversionRate": 11.1
},
"ExtendedProperties": [
{
"RowId": "e3eb8270-0511-47d6-9a29-9ac5251a386d",
"Name": "sample string 2",
"Value": "sample string 3",
"Type": "sample string 4"
},
{
}
],
"FolderName": [
"sample string 1",
"sample string 2"
],
"Items": [
{
"ItemId": "855bae95-7961-43ff-8772-a74d0a83db32",
"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": "69807495-6857-44bc-8402-e7b95d3088a9",
"Rowid": "d71e81f9-f428-442b-8a10-cf7adb855fcc",
"pkPurchaseId": "82eab989-7782-49ea-b96d-31d95d92b571",
"ExternalInvoiceNumber": "sample string 4",
"fkSupplierId": "9930e275-89f7-4c69-ae77-4ea37b784571",
"DateOfDelivery": "2019-11-28T09:46:01.5666966+00:00",
"QuotedDeliveryDate": "2019-11-28T09:46:01.5666966+00:00",
"SupplierName": "sample string 8",
"fkLocationId": "4612fbe1-89ee-47ec-afeb-966688612559"
},
"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": "9d620a07-1e1f-4606-b23e-508000318ee9",
"AdditionalInfo": [
{
"pkOptionId": "b2d660ee-9f31-4bc7-b381-5d1f7c33f944",
"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": "f7944759-e062-451c-8bb2-f879ed84b54d",
"BatchId": 1,
"OrderItemBatchId": 1
},
{
}
],
"InventoryTrackingType": 33,
"isBatchedStockItem": false,
"IsWarehouseManaged": true,
"HasPurchaseOrders": true,
"CanPurchaseOrderFulfil": true,
"IsUnlinked": false,
"RowId": "f3f8854f-ab32-43fa-a860-a1d50a3c72b8",
"OrderId": "02d85820-2f8f-446f-bdc3-11058824ba5a",
"StockItemId": "e882bfae-ee93-4d52-9e86-2a0e9fd543c7"
},
{
}
],
"Notes": [
{
"OrderNoteId": "5708db80-2a04-44b5-86ed-61c89534334b",
"OrderId": "4a31ca31-bafd-478a-a358-5e9be80b3a86",
"NoteDate": "2019-11-28T09:46:01.5666966+00:00",
"Internal": true,
"Note": "sample string 5",
"CreatedBy": "sample string 6",
"NoteTypeId": 64
},
{
}
]
}