Retrieves a list of order details for a given order reference number, returns maximum of 50 orders.
For eBay orders, if Sellling Manager Pro sales number is available the order can be retrived by this number
Name | Type | Description |
---|---|---|
ReferenceId | String | Order reference id, or SecondaryReferenceNumber |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/Orders/GetOrderDetailsByReferenceId
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
This is an example of the request structure. Results will vary depending on your data.
ReferenceId=sample string 1
This is an example of the response JSON. Results will vary depending on your data.
[
{
"OrderId": "39e48ec9-0a55-42d0-a210-25b414db1fa2",
"NumOrderId": 2,
"Processed": true,
"ProcessedDateTime": "2022-08-03T16:02:33.929857+01:00",
"FulfilmentLocationId": "82a7805b-0ace-47dc-823a-56f42aa6fdd1",
"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": "4acf7329-5804-406e-8fbd-4e5a5bf21a6c",
"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-08-03T16:02:33.929857+01:00",
"Source": "sample string 14",
"SubSource": "sample string 15",
"SiteCode": "sample string 16",
"HoldOrCancel": true,
"DespatchByDate": "2022-08-03T16:02:33.929857+01:00",
"ScheduledDelivery": {
"From": "2022-08-03T16:02:33.929857+01:00",
"To": "2022-08-03T16:02:33.929857+01:00"
},
"HasScheduledDelivery": true,
"Location": "921f9da0-08ee-470b-9759-846591546c09",
"NumItems": 20,
"PickwaveIds": [
1
],
"StockAllocationType": 0
},
"ShippingInfo": {
"Vendor": "sample string 1",
"PostalServiceId": "8e6a8265-67f4-4c34-a7c6-c0d3fc1aeac6",
"PostalServiceName": "sample string 3",
"TotalWeight": 4.0,
"ItemWeight": 5.0,
"PackageCategoryId": "8e571eab-1f79-4461-b0f5-bac7afad5dc8",
"PackageCategory": "sample string 7",
"PackageTypeId": "6a9fed89-47e9-486b-8ab2-8f410fd40cf8",
"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": "f839fa00-8332-447e-9a9d-b2bf8940047a"
},
"BillingAddress": {
}
},
"TotalsInfo": {
"Subtotal": 2.1,
"PostageCost": 3.1,
"PostageCostExTax": 4.1,
"Tax": 5.1,
"TotalCharge": 6.1,
"PaymentMethod": "sample string 7",
"PaymentMethodId": "23db2c2c-dc40-4fcd-a138-19a9a212373f",
"ProfitMargin": 9.1,
"TotalDiscount": 10.1,
"Currency": "sample string 11",
"CountryTaxRate": 12.1,
"ConversionRate": 13.1
},
"ExtendedProperties": [
{
"RowId": "d7ee3a08-bcd3-4b92-91ec-19a5c95efddb",
"Name": "sample string 2",
"Value": "sample string 3",
"Type": "sample string 4"
}
],
"FolderName": [
"sample string 1"
],
"Items": [
{
"ItemId": "d12b9f0a-372e-4669-b521-14208befb926",
"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": "b3451baa-6e1a-41e9-b7d6-e2b7880f3c5f",
"Rowid": "745c6a37-42de-44be-b618-b9dad80e4640",
"pkPurchaseId": "cfc612a3-6fe3-4ddb-9d52-27e0353f4d95",
"ExternalInvoiceNumber": "sample string 4",
"fkSupplierId": "ded8dca0-ba10-425e-8f17-7bdc102de33a",
"DateOfDelivery": "2022-08-03T16:02:33.929857+01:00",
"QuotedDeliveryDate": "2022-08-03T16:02:33.929857+01:00",
"SupplierName": "sample string 8",
"fkLocationId": "d6b8043a-e3d6-4857-b40f-e582a3e3e77c"
},
"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": "11cd3ed1-d6af-4004-aecd-f7150ba6338d",
"AdditionalInfo": [
{
"pkOptionId": "452d1f3a-ccdc-401f-93ce-66e407f86cc9",
"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": "c90f625e-5d93-4815-96f5-701669e101c9",
"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": "f6a705da-8434-4c62-9e44-31a21d310de2",
"LogicalDelete": true
}
],
"RowId": "b9eb6e79-093f-4f3d-a356-ed38b0952e01",
"OrderId": "767c407d-cab1-4877-bfac-acf3c2d69662",
"StockItemId": "fad27b53-dc70-4476-99e6-075217e56be9"
}
],
"Notes": [
{
"OrderNoteId": "29595dc6-911d-40ef-b46a-4fcbdbe107fb",
"OrderId": "9789f5a3-d57e-4b8a-8b40-701c65f0ac0a",
"NoteDate": "2022-08-03T16:02:33.9308542+01:00",
"Internal": true,
"Note": "sample string 5",
"CreatedBy": "sample string 6",
"NoteTypeId": 64
}
],
"PaidDateTime": "2022-08-03T16:02:33.9308542+01:00",
"TaxId": "sample string 5"
}
]