Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

Orders /GetOrderById

Allows 150 calls per minute

Response: OrderDetails



Retrieves the order detail for a unique system order id identifier (pkOrderId)
For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails

Parameters

NameTypeDescription
pkOrderIdGuidpkOrderId

Permissions

GlobalPermissions.OrderBook.ViewOrderDetailsNode

Example Request

The following request format is required for this method.

Endpoint URL

GET | POST https://eu-ext.linnworks.net/api/Orders/GetOrderById

Headers

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

Request Body

This is an example of the request structure. Results will vary depending on your data.

pkOrderId=8b08a235-be7e-4ee5-b229-e2a317378b7e

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "OrderId": "2db19da1-0a92-4fc4-beb6-aed2a926aace",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2022-09-05T15:10:05.4177674+03:00",
  "FulfilmentLocationId": "6d84c50f-7453-4a47-8326-834cceb8beb4",
  "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": "ca0d41e3-d0ae-466e-ae5d-d17d40f41a16",
        "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": "2022-09-05T15:10:05.4177674+03:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2022-09-05T15:10:05.4177674+03:00",
    "ScheduledDelivery": {
      "From": "2022-09-05T15:10:05.4177674+03:00",
      "To": "2022-09-05T15:10:05.4177674+03:00"
    },
    "HasScheduledDelivery": true,
    "Location": "bd78e71e-eea6-4153-927e-0c03a87f6278",
    "NumItems": 20,
    "PickwaveIds": [
      1
    ],
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "5f601fdd-f8ba-4ae0-9348-dd03b3462bff",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.0,
    "ItemWeight": 5.0,
    "PackageCategoryId": "981f8799-c4ed-4480-bd60-d8f2e659437d",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "27b3b097-ef54-4a64-a26d-33eb0b519139",
    "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": "dcdd0ccc-28e3-4d1f-b8da-e78cd5a20fda"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 2.1,
    "PostageCost": 3.1,
    "PostageCostExTax": 4.1,
    "Tax": 5.1,
    "TotalCharge": 6.1,
    "PaymentMethod": "sample string 7",
    "PaymentMethodId": "3bcce7b7-5b8d-4fab-b5f4-1c88725f30e2",
    "ProfitMargin": 9.1,
    "TotalDiscount": 10.1,
    "Currency": "sample string 11",
    "CountryTaxRate": 12.1,
    "ConversionRate": 13.1
  },
  "ExtendedProperties": [
    {
      "RowId": "5dc4e82b-a558-4d0b-9860-a50d55ddd0f4",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "FolderName": [
    "sample string 1"
  ],
  "Items": [
    {
      "ItemId": "0edcebe4-d2b0-4547-8d07-1c6d7f2d132f",
      "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": "bd706679-1a33-42e6-bf0e-209e6c9da464",
        "Rowid": "e2dc362f-977b-44af-a671-979507288ede",
        "pkPurchaseId": "13671fa4-84fa-4de0-8eba-736f03f8e139",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "46ebc6bc-a612-4795-8452-08751efc9358",
        "DateOfDelivery": "2022-09-05T15:10:05.4187549+03:00",
        "QuotedDeliveryDate": "2022-09-05T15:10:05.4187549+03:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "7d9403bc-29f3-4176-ad61-047025f7cf86"
      },
      "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": "6e3dbf17-ea77-496c-871d-bec7893c2873",
      "AdditionalInfo": [
        {
          "pkOptionId": "37cc4698-5a95-47e5-b492-1add1117fa4b",
          "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": "94251cc3-9911-4c6f-b409-fa195a72dd50",
          "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": "63da342a-5b79-40de-be03-5f2d87ea8c9f",
          "LogicalDelete": true
        }
      ],
      "RowId": "68f9bff6-80dc-4ebf-97b1-03d69b4fd527",
      "OrderId": "eca8d959-ba24-472e-bef8-839c40edfc18",
      "StockItemId": "921028cf-9f7f-42df-91e3-45b670cbffd4"
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "9d2f046d-480f-4027-af56-f328e68c7036",
      "OrderId": "681485ff-6d99-4559-bdca-b5ed01f9de9f",
      "NoteDate": "2022-09-05T15:10:05.4187549+03:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    }
  ],
  "PaidDateTime": "2022-09-05T15:10:05.4187549+03:00",
  "TaxId": "sample string 5"
}