Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

Orders /GetOrderDetailsByNumOrderId

Allows 250 calls per minute

Response: OrderDetails



Retrieves the order detail for a given order numeric id. If not found empty class is returned.
For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails

Parameters

NameTypeDescription
OrderIdInt32Order Id (numeric)

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/GetOrderDetailsByNumOrderId

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.

OrderId=1

Response

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

{
  "OrderId": "dffdb1ea-1905-40e7-abd1-2ca80ab10487",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2023-01-10T13:49:54.4894959+00:00",
  "FulfilmentLocationId": "ab1a9fbd-3b4b-45a5-a178-0f76ccebf037",
  "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": "ac6a9b79-ad1d-420f-9e6c-e6ba52ce076c",
        "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": "2023-01-10T13:49:54.4894959+00:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2023-01-10T13:49:54.4894959+00:00",
    "ScheduledDelivery": {
      "From": "2023-01-10T13:49:54.4894959+00:00",
      "To": "2023-01-10T13:49:54.4894959+00:00"
    },
    "HasScheduledDelivery": true,
    "Location": "cbed17ea-cdc6-4ddc-9ca8-cdb8ae033de8",
    "NumItems": 20,
    "PickwaveIds": [
      1
    ],
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "80540595-8ac8-4b39-93d7-33177ce82bd9",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.0,
    "ItemWeight": 5.0,
    "PackageCategoryId": "d5d868b9-d633-47b5-b748-a9d1429b5216",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "2a57cdc3-1331-4657-a1a4-84a3c0d8de27",
    "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": "2bf71276-8284-422f-aef5-f05a6bed32d8"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 2.1,
    "PostageCost": 3.1,
    "PostageCostExTax": 4.1,
    "Tax": 5.1,
    "TotalCharge": 6.1,
    "PaymentMethod": "sample string 7",
    "PaymentMethodId": "146923fd-6816-4adf-953c-64ac4e75129d",
    "ProfitMargin": 9.1,
    "TotalDiscount": 10.1,
    "Currency": "sample string 11",
    "CountryTaxRate": 12.1,
    "ConversionRate": 13.1
  },
  "ExtendedProperties": [
    {
      "RowId": "6095f8fd-1481-4967-918e-8aa771a0b378",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "FolderName": [
    "sample string 1"
  ],
  "Items": [
    {
      "ItemId": "7ae98eff-d8d0-443a-acf8-06038ca93eaf",
      "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": "b09ffae3-82b3-4449-8577-5e83e4db0eb4",
        "Rowid": "622340e7-1f42-45c3-bf7a-2d75b12fc871",
        "pkPurchaseId": "4c399707-f964-4bb8-af82-caeab3c32399",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "f57f7d7f-e698-4f8b-baab-efbe4418a13f",
        "DateOfDelivery": "2023-01-10T13:49:54.4894959+00:00",
        "QuotedDeliveryDate": "2023-01-10T13:49:54.4894959+00:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "2ba5db38-c483-4d2b-9f70-226a5c445539"
      },
      "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": "543c47e7-ec7a-44dd-ac04-df251c584d2e",
      "AdditionalInfo": [
        {
          "pkOptionId": "39b2fe0e-831e-41d0-b9eb-01832bb1fe17",
          "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": "486e7c93-837a-49ed-81fb-897f60f0af22",
          "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": "c3d7a0f3-4eb7-4a66-8c54-db4bce0e68d2",
          "LogicalDelete": true
        }
      ],
      "RowId": "5d68a2ba-3add-47cd-aa1d-dafa228d6fe9",
      "OrderId": "6ed5a67c-f36e-4f1b-8054-6e4dd9d5ac50",
      "StockItemId": "cc327b61-64fe-4fd3-a485-f5e29568fa67"
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "e4812138-68c3-4afe-a539-08615707876c",
      "OrderId": "402ed7bb-5914-4eb2-8dfc-aabea96f8f63",
      "NoteDate": "2023-01-10T13:49:54.4894959+00:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    }
  ],
  "PaidDateTime": "2023-01-10T13:49:54.4894959+00:00",
  "TaxId": "sample string 5"
}