Back

Search

Search

Methods

Inventory

Orders

Orders /GetOrderById

Response: OrderDetails



Retrieves the order detail for a unique system order id identifier (pkOrderId)

Parameters

NameTypeDescription
pkOrderIdGuidpkOrderId

HTTP Endpoint

Server /Orders / GetOrderById

Permissions

GlobalPermissions.OrderBook.ViewOrderDetailsNode

Example Code

Example Request

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=e18ef55c-633a-4723-ad5b-46813a187af5

Response

This is an example response. Results may vary depending on your data.

{
  "OrderId": "379591e2-f4a6-4c56-a727-4b53e8fb1709",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2019-06-12T09:27:52.8752202+01:00",
  "FulfilmentLocationId": "c1af746f-f72c-49e7-8873-ab1c61b51d07",
  "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": "118b7f56-586c-4374-a4d5-c21c3ee92da8",
        "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-06-12T09:27:52.8752202+01:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2019-06-12T09:27:52.8752202+01:00",
    "ScheduledDelivery": {
      "From": "2019-06-12T09:27:52.8752202+01:00",
      "To": "2019-06-12T09:27:52.8752202+01:00"
    },
    "HasScheduledDelivery": true,
    "Location": "9c7ecc19-2685-474c-8f7d-4f38ff531dda",
    "NumItems": 20,
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "db0ef67b-bf41-4a92-8682-c75ec413d3d4",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.1,
    "ItemWeight": 5.1,
    "PackageCategoryId": "0fd8ef3f-4dc8-4a1f-9294-feac419a4cf0",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "50ba6754-8650-4d23-bbcd-30b4a99653c7",
    "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": "52eec655-8213-468e-802d-8866cb733f40"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 1.1,
    "PostageCost": 2.1,
    "Tax": 3.1,
    "TotalCharge": 4.1,
    "PaymentMethod": "sample string 5",
    "PaymentMethodId": "cc52a477-2755-404b-8814-e53457d2b169",
    "ProfitMargin": 7.1,
    "TotalDiscount": 8.1,
    "Currency": "sample string 9",
    "CountryTaxRate": 10.1,
    "ConversionRate": 11.1
  },
  "ExtendedProperties": [
    {
      "RowId": "c929a7a2-e5a0-433f-8b7d-ea31f77604f4",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    },
    {
    }
  ],
  "FolderName": [
    "sample string 1",
    "sample string 2"
  ],
  "Items": [
    {
      "ItemId": "b8b4a572-dde6-4748-bef0-9fd8dbc24406",
      "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": "9288bca4-0915-452e-9005-932f9d2adf6c",
        "Rowid": "3ac0bb7d-0534-4634-9257-25edbe293d2c",
        "pkPurchaseId": "cb7281cb-dcca-4ea8-b3a6-dfc4b1cdbdd8",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "6c7e4a8a-b839-4dfc-8579-2216d93472c6",
        "DateOfDelivery": "2019-06-12T09:27:52.8762212+01:00",
        "QuotedDeliveryDate": "2019-06-12T09:27:52.8762212+01:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "74981f4b-79f2-4d09-8b51-316f76edeedd"
      },
      "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": "5682651d-ea8b-4f3b-abaf-adc35f475087",
      "AdditionalInfo": [
        {
          "pkOptionId": "088b9355-b331-4026-b497-ff64446d19bd",
          "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": "9aecef13-d700-4cff-9384-ba43903ff839",
          "BatchId": 1,
          "OrderItemBatchId": 1
        },
        {
        }
      ],
      "InventoryTrackingType": 33,
      "isBatchedStockItem": false,
      "IsWarehouseManaged": true,
      "HasPurchaseOrders": true,
      "CanPurchaseOrderFulfil": true,
      "IsUnlinked": false,
      "RowId": "ce1d4cff-110f-4102-ac26-71c9d2b2db30",
      "OrderId": "b4d2af1f-4879-41c4-8ed3-e20595c28d66",
      "StockItemId": "815ac8f3-03a8-461f-884a-f3c3d53453aa"
    },
    {
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "cf57a258-9b3d-40c6-98b0-b6192547a466",
      "OrderId": "e57be95b-48ca-47cd-8799-947e0d457ebc",
      "NoteDate": "2019-06-12T09:27:52.8762212+01:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    },
    {
    }
  ]
}