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=a5a95056-d306-4201-afde-b5198133db20

Response

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

{
  "OrderId": "32d13565-713a-4a9e-8498-eb3524654528",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2018-10-03T11:12:36.4278677+01:00",
  "FulfilmentLocationId": "fab21aa3-9472-45e3-9cbb-146536e5c9eb",
  "GeneralInfo": {
    "Status": 1,
    "LabelPrinted": true,
    "LabelError": "sample string 3",
    "InvoicePrinted": true,
    "PickListPrinted": true,
    "IsRuleRun": true,
    "Notes": 7,
    "PartShipped": true,
    "Marker": 64,
    "IsParked": true,
    "Identifiers": null,
    "ReferenceNum": "sample string 10",
    "SecondaryReference": "sample string 11",
    "ExternalReferenceNum": "sample string 12",
    "ReceivedDate": "2018-10-03T11:12:36.4278677+01:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2018-10-03T11:12:36.4278677+01:00",
    "ScheduledDelivery": {
      "From": "2018-10-03T11:12:36.4278677+01:00",
      "To": "2018-10-03T11:12:36.4278677+01:00"
    },
    "HasScheduledDelivery": true,
    "Location": "f9630960-7bd6-48c3-b6ff-79503247fd7a",
    "NumItems": 20,
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "0be11945-a25a-42b6-96cf-e6f8163b1fa2",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.1,
    "ItemWeight": 5.1,
    "PackageCategoryId": "6fb04f6e-6b78-407d-a573-24f3ce8b184c",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "8c39d864-268c-4e47-a508-07d1066e212f",
    "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": "c2f4a2da-9042-4b4c-b9ed-747ec9895269"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 1.1,
    "PostageCost": 2.1,
    "Tax": 3.1,
    "TotalCharge": 4.1,
    "PaymentMethod": "sample string 5",
    "PaymentMethodId": "f3b2d807-a0de-47a2-aeb7-a16251fa8e0a",
    "ProfitMargin": 7.1,
    "TotalDiscount": 8.1,
    "Currency": "sample string 9",
    "CountryTaxRate": 10.1,
    "ConversionRate": 11.1
  },
  "ExtendedProperties": [
    {
      "RowId": "f53fdd72-054a-4bf9-ac61-f07f27494a85",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    },
    {
    }
  ],
  "FolderName": [
    "sample string 1",
    "sample string 2"
  ],
  "Items": [
    {
      "ItemId": "67f6ab62-0f87-4b8c-bff2-f0b8ec732894",
      "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,
      "InOrderBook": 1,
      "Level": 11,
      "MinimumLevel": 1,
      "AvailableStock": 12,
      "PricePerUnit": 13.1,
      "UnitCost": 14.1,
      "Discount": 15.1,
      "Tax": 20.1,
      "TaxRate": 16.1,
      "Cost": 17.1,
      "CostIncTax": 18.1,
      "CompositeSubItems": [
        {
        },
        {
        }
      ],
      "IsService": true,
      "SalesTax": 20.1,
      "TaxCostInclusive": true,
      "PartShipped": true,
      "Weight": 23.1,
      "BarcodeNumber": "sample string 24",
      "Market": 25,
      "ChannelSKU": "sample string 26",
      "ChannelTitle": "sample string 27",
      "DiscountValue": 10.222739018087856,
      "HasImage": true,
      "ImageId": "318bfb7c-1567-4258-a204-4be7e261af4c",
      "AdditionalInfo": [
        {
          "pkOptionId": "bd94d96a-ffb0-4350-91d5-402490066794",
          "Property": "sample string 2",
          "Value": "sample string 3"
        },
        {
        }
      ],
      "StockLevelIndicator": 28,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "BinRack": "sample string 31",
      "BinRacks": [
        {
          "Quantity": 1,
          "BinRack": "sample string 2",
          "Location": "2aa3ccd0-4914-47c5-bbf3-b3ebdc7d3bd6",
          "BatchId": 1,
          "OrderItemBatchId": 1
        },
        {
        }
      ],
      "InventoryTrackingType": 32,
      "isBatchedStockItem": false,
      "HasPurchaseOrders": true,
      "CanPurchaseOrderFulfil": true,
      "IsUnlinked": false,
      "RowId": "8a908e78-36fd-4ec9-a5d7-18502b45769e",
      "OrderId": "cce9e92f-3911-4840-ab2d-e7553a7eeeb9",
      "StockItemId": "083efb68-2569-4dad-a4f2-042b5aa4000b"
    },
    {
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "aa25486f-03e5-43a9-930a-4d40115903e3",
      "OrderId": "1725555d-d97e-4714-8e58-393b49ae9725",
      "NoteDate": "2018-10-03T11:12:36.4288684+01:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    },
    {
    }
  ]
}