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.ViewOrderDetails.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=e74f59a7-49a8-4619-a0c1-6f3a6d4404f1

Response

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

{
  "OrderId": "60a415b9-bcef-4890-91c4-f5e75218b555",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2018-02-19T16:57:08.4381478+00:00",
  "FulfilmentLocationId": "aea182bf-ec3e-4774-b108-a48eb22f0511",
  "GeneralInfo": {
    "Status": 1,
    "LabelPrinted": true,
    "LabelError": "sample string 3",
    "InvoicePrinted": true,
    "PickListPrinted": true,
    "IsRuleRun": true,
    "Notes": 7,
    "PartShipped": true,
    "Marker": 64,
    "ReferenceNum": "sample string 9",
    "SecondaryReference": "sample string 10",
    "ExternalReferenceNum": "sample string 11",
    "ReceivedDate": "2018-02-19T16:57:08.4381478+00:00",
    "Source": "sample string 13",
    "SubSource": "sample string 14",
    "SiteCode": "sample string 15",
    "HoldOrCancel": true,
    "DespatchByDate": "2018-02-19T16:57:08.4381478+00:00",
    "Location": "bab3b0c2-f853-40f2-9375-d6d258c41035",
    "NumItems": 19
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "192ea1a6-dc9b-4f29-b775-5553676cb19b",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.1,
    "ItemWeight": 5.1,
    "PackageCategoryId": "c7d42a16-8015-4f41-869e-f391152ebaa1",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "1da27314-f3b8-41ab-abc7-c84159c54f16",
    "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",
      "FullName": "sample string 9",
      "Company": "sample string 10",
      "PhoneNumber": "sample string 11",
      "CountryId": "a8f20f15-8e77-4032-aacc-88a9dfe7e460"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 1.1,
    "PostageCost": 2.1,
    "Tax": 3.1,
    "TotalCharge": 4.1,
    "PaymentMethod": "sample string 5",
    "PaymentMethodId": "3cd74b38-3bbe-4e81-bb96-d19ec33e77e9",
    "ProfitMargin": 7.1,
    "TotalDiscount": 8.1,
    "Currency": "sample string 9",
    "CountryTaxRate": 10.1,
    "ConversionRate": 11.1
  },
  "ExtendedProperties": [
    {
      "RowId": "a3dc5db2-710f-4062-b631-8640e9deb412",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    },
    {
    }
  ],
  "FolderName": [
    "sample string 1",
    "sample string 2"
  ],
  "Items": [
    {
      "OrderId": "56835090-ec35-44dc-bb78-5c31e6ad66a1",
      "ItemId": "850a4219-4b01-4aec-8e6b-71e14aaa2fa1",
      "StockItemId": "fd9a1ae7-6dbd-4a93-8577-615db4af9d63",
      "ItemNumber": "sample string 4",
      "SKU": "sample string 5",
      "ItemSource": "sample string 6",
      "Title": "sample string 7",
      "Quantity": 8,
      "CategoryName": "sample string 9",
      "CompositeAvailablity": 1,
      "RowId": "308a8488-b5e0-42e2-88e6-bce0767820d6",
      "StockLevelsSpecified": true,
      "OnOrder": 12,
      "InOrderBook": 1,
      "Level": 13,
      "MinimumLevel": 1,
      "AvailableStock": 14,
      "PricePerUnit": 15.1,
      "UnitCost": 16.1,
      "Discount": 17.1,
      "Tax": 22.1,
      "TaxRate": 18.1,
      "Cost": 19.1,
      "CostIncTax": 20.1,
      "CompositeSubItems": [
        {
        },
        {
        }
      ],
      "IsService": true,
      "SalesTax": 22.1,
      "TaxCostInclusive": true,
      "PartShipped": true,
      "Weight": 25.1,
      "BarcodeNumber": "sample string 26",
      "Market": 27,
      "ChannelSKU": "sample string 28",
      "ChannelTitle": "sample string 29",
      "DiscountValue": 17.490939881456391,
      "HasImage": true,
      "ImageId": "872af4e0-be2e-49e6-ae51-37409e8964d2",
      "AdditionalInfo": [
        {
          "pkOptionId": "3d338899-7a41-4d9c-b18f-eb40cfee2dc5",
          "Property": "sample string 2",
          "Value": "sample string 3"
        },
        {
        }
      ],
      "StockLevelIndicator": 30,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "BinRack": "sample string 33",
      "BinRacks": [
        {
          "Quantity": 1,
          "BinRack": "sample string 2",
          "Location": "c4116c9e-190c-42d3-844d-dcd467595cbb"
        },
        {
        }
      ],
      "InventoryTrackingType": 34,
      "isBatchedStockItem": false
    },
    {
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "e148e0da-cd55-46aa-ab43-8fd70e89e7b2",
      "OrderId": "e0e55295-a8f3-4ca2-9f21-72a9eabc524e",
      "NoteDate": "2018-02-19T16:57:08.4381478+00:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    },
    {
    }
  ]
}