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=8bb61a5c-dfca-405e-a2f5-2d732ab3f450

Response

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

{
  "OrderId": "9b7ea033-3b67-4f2c-aa90-ac5ce593a074",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2019-07-23T15:31:56.8148317+01:00",
  "FulfilmentLocationId": "7c9d0d16-cbd4-4a36-81da-4baa1d12b831",
  "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": "47b29b13-0596-4dc0-82e8-2ecde78116fc",
        "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-07-23T15:31:56.8148317+01:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2019-07-23T15:31:56.8148317+01:00",
    "ScheduledDelivery": {
      "From": "2019-07-23T15:31:56.8148317+01:00",
      "To": "2019-07-23T15:31:56.8148317+01:00"
    },
    "HasScheduledDelivery": true,
    "Location": "878b48f8-5411-4e4e-a48c-cd4d1d1c60f0",
    "NumItems": 20,
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "4db5f7de-fece-48a1-844f-1d9a853a402f",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.1,
    "ItemWeight": 5.1,
    "PackageCategoryId": "87e9b166-bc73-4d28-ba17-bdb3fa87428e",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "2fadea85-de07-4ee4-adc7-5366b1055bda",
    "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": "27e415ea-a678-4823-9c8d-44b6a09eace1"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 1.1,
    "PostageCost": 2.1,
    "Tax": 3.1,
    "TotalCharge": 4.1,
    "PaymentMethod": "sample string 5",
    "PaymentMethodId": "f6876c76-0dd1-4745-9fd0-5760e48dc598",
    "ProfitMargin": 7.1,
    "TotalDiscount": 8.1,
    "Currency": "sample string 9",
    "CountryTaxRate": 10.1,
    "ConversionRate": 11.1
  },
  "ExtendedProperties": [
    {
      "RowId": "38f7ce2b-d1c6-4d29-9b7f-8d51bf0c1c13",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    },
    {
    }
  ],
  "FolderName": [
    "sample string 1",
    "sample string 2"
  ],
  "Items": [
    {
      "ItemId": "82859a3b-4935-4f8f-9624-e26c98ce0259",
      "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": "a4b042a0-2d5e-41d3-a3e3-93e78d57944a",
        "Rowid": "8b18e48c-9a80-449d-a34d-fb5b1b1a93f5",
        "pkPurchaseId": "18365b63-5f43-48b0-ba72-8e2014e4ee02",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "5f8b3097-9fef-4212-956c-c5a890725448",
        "DateOfDelivery": "2019-07-23T15:31:56.8148317+01:00",
        "QuotedDeliveryDate": "2019-07-23T15:31:56.8148317+01:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "8c7a0aff-909d-4f31-ac4c-e555b08e876e"
      },
      "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": "8d5570ce-bdd1-47fc-b919-0644d2073eab",
      "AdditionalInfo": [
        {
          "pkOptionId": "6694ab5f-70d9-4ba1-878c-d4ad4a5991df",
          "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": "b8a90b7a-efbc-4f5b-aec7-c4ec6604ad8e",
          "BatchId": 1,
          "OrderItemBatchId": 1
        },
        {
        }
      ],
      "InventoryTrackingType": 33,
      "isBatchedStockItem": false,
      "IsWarehouseManaged": true,
      "HasPurchaseOrders": true,
      "CanPurchaseOrderFulfil": true,
      "IsUnlinked": false,
      "RowId": "000910ed-6219-41d2-ad9d-7dbcb08e58f2",
      "OrderId": "844d82f1-16f3-42d4-9242-befe5fe8752f",
      "StockItemId": "91104329-1bf7-4cd8-a5d1-e7f6a1ebbed4"
    },
    {
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "b9df1625-3c54-457c-a64e-226b9bc76ca6",
      "OrderId": "b4774e7a-2232-4a8d-b7e8-d0685485e65c",
      "NoteDate": "2019-07-23T15:31:56.8148317+01:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    },
    {
    }
  ]
}