Get a specific open order
Name | Type | Description |
---|---|---|
orderId | Guid | Order id |
fulfilmentLocationId | Nullable<Guid> | Current fulfilment center |
loadItems | Boolean | Load or not the order items information |
loadAdditionalInfo | Boolean | Load or not the order additional info |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/Orders/GetOrder
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.
orderId=ac9897eb-351d-4495-b392-bbd02ee550ba&fulfilmentLocationId=cd81791a-290d-49b0-94e0-8547ef53a478&loadItems=true&loadAdditionalInfo=true
This is an example of the response JSON. Results will vary depending on your data.
{
"NumOrderId": 1,
"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": "8d1cff05-0557-4201-b98b-a86560375acc",
"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.6466995+00:00",
"Source": "sample string 14",
"SubSource": "sample string 15",
"SiteCode": "sample string 16",
"HoldOrCancel": true,
"DespatchByDate": "2023-01-10T13:49:54.6466995+00:00",
"ScheduledDelivery": {
"From": "2023-01-10T13:49:54.6466995+00:00",
"To": "2023-01-10T13:49:54.6466995+00:00"
},
"HasScheduledDelivery": true,
"Location": "fb96bb1c-6ae9-4557-a978-1347c47569fc",
"NumItems": 20,
"PickwaveIds": [
1
],
"StockAllocationType": 0
},
"ShippingInfo": {
"Vendor": "sample string 1",
"PostalServiceId": "c1c26064-5962-441d-bda6-2efc0baa5680",
"PostalServiceName": "sample string 3",
"TotalWeight": 4.0,
"ItemWeight": 5.0,
"PackageCategoryId": "ffa93f93-f34a-4cb5-baa1-82caef812947",
"PackageCategory": "sample string 7",
"PackageTypeId": "139e5b76-7033-4d7d-98ea-fc25a1dc884a",
"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": "b354e429-ad7c-4ec9-97e4-ea3db26f160d"
},
"BillingAddress": {
}
},
"TotalsInfo": {
"Subtotal": 2.1,
"PostageCost": 3.1,
"PostageCostExTax": 4.1,
"Tax": 5.1,
"TotalCharge": 6.1,
"PaymentMethod": "sample string 7",
"PaymentMethodId": "8bc1551c-725f-41b6-8b08-77bc4e9b6679",
"ProfitMargin": 9.1,
"TotalDiscount": 10.1,
"Currency": "sample string 11",
"CountryTaxRate": 12.1,
"ConversionRate": 13.1
},
"TaxInfo": {
"TaxNumber": "sample string 1"
},
"FolderName": [
"sample string 1"
],
"IsPostFilteredOut": true,
"CanFulfil": true,
"Fulfillment": {
"FulfillmentState": 0,
"PurchaseOrderState": 1
},
"Items": [
{
"ItemId": "4dde7303-e270-4d20-9c58-acbf1d38c90a",
"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": "f6df39f8-2ea3-4d85-a563-a548acbe3b0c",
"Rowid": "0e7107fb-63e8-4773-8ba4-de484064648d",
"pkPurchaseId": "e93da780-843c-4bf0-a943-bbbc7636bd38",
"ExternalInvoiceNumber": "sample string 4",
"fkSupplierId": "5e2c901f-f8af-4b2a-9523-ed7d819ca24a",
"DateOfDelivery": "2023-01-10T13:49:54.6466995+00:00",
"QuotedDeliveryDate": "2023-01-10T13:49:54.6466995+00:00",
"SupplierName": "sample string 8",
"fkLocationId": "2e9e02bf-6600-4a8f-ab24-7172af0df304"
},
"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": "a0352ab6-286b-407c-b3bc-ad514cf87169",
"AdditionalInfo": [
{
"pkOptionId": "580ac069-6efe-42c3-9577-bdf0e8af8592",
"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": "de8e3348-c792-4c4a-82a8-e0c6014945ee",
"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": "c0ba952e-746e-4f04-80e3-6681800855d2",
"LogicalDelete": true
}
],
"RowId": "6803fa56-1efc-4c4b-a7c0-ad7894090aa0",
"OrderId": "2405470a-5421-4ed6-921e-614329b5507b",
"StockItemId": "09345859-22a3-4bc2-aa26-8d5bf4a795e6"
}
],
"HasItems": true,
"TotalItemsSum": 0,
"OrderId": "ab98ed0f-69c8-4558-abd3-0ec8db1e9967"
}