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

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": "d6484fc5-ed82-4b22-ae1a-485430066ecd",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2022-03-09T13:04:14.200692+00:00",
  "FulfilmentLocationId": "51e71aeb-4615-4df6-94d1-fbfe5fa20106",
  "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": "10781d01-8d77-44f3-acee-c85951954625",
        "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-03-09T13:04:14.200692+00:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2022-03-09T13:04:14.200692+00:00",
    "ScheduledDelivery": {
      "From": "2022-03-09T13:04:14.200692+00:00",
      "To": "2022-03-09T13:04:14.200692+00:00"
    },
    "HasScheduledDelivery": true,
    "Location": "b10bf1c9-d3a0-45e2-aa85-19b2c0a36cdf",
    "NumItems": 20,
    "PickwaveIds": [
      1
    ],
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "cc62b09f-8ead-43e4-b1bc-94a4a03c93ea",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.0,
    "ItemWeight": 5.0,
    "PackageCategoryId": "5968aa94-405e-4019-abb4-42ddf602396a",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "e3eb0d6b-d060-4a4c-ac69-406d5a02953c",
    "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": "3f287440-d772-4bce-99bb-42d030aa6d07"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 2.1,
    "PostageCost": 3.1,
    "PostageCostExTax": 4.1,
    "Tax": 5.1,
    "TotalCharge": 6.1,
    "PaymentMethod": "sample string 7",
    "PaymentMethodId": "1a9df403-fb87-4fdc-9aa9-0d43e7f07cb6",
    "ProfitMargin": 9.1,
    "TotalDiscount": 10.1,
    "Currency": "sample string 11",
    "CountryTaxRate": 12.1,
    "ConversionRate": 13.1
  },
  "ExtendedProperties": [
    {
      "RowId": "45a1c0a2-2a6a-4e07-acc5-056d14af990e",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "FolderName": [
    "sample string 1"
  ],
  "Items": [
    {
      "ItemId": "51b56c48-0d0b-4f8a-a432-20328809af69",
      "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": "83bda840-67bb-44f3-818b-2e77868e63ba",
        "Rowid": "1f679406-9672-46c1-8893-0ad07c7edd99",
        "pkPurchaseId": "e3ee4417-25f3-45d1-99ac-f6a6fbffeefc",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "1de0539d-9a66-4c48-9011-f3723d0a7087",
        "DateOfDelivery": "2022-03-09T13:04:14.2016903+00:00",
        "QuotedDeliveryDate": "2022-03-09T13:04:14.2016903+00:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "1b8160c4-79d1-4352-8b71-4a9b3a78de55"
      },
      "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": "0b051e74-80bf-48b5-9d93-6b431f647e43",
      "AdditionalInfo": [
        {
          "pkOptionId": "5c6f691a-f989-4bec-9955-fd53f03a04e4",
          "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": "aaf5fea8-02ba-4c5b-b85a-40120038e6ab",
          "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": "6e2ae86f-62f9-41f4-a406-7f616e20ce2a",
          "LogicalDelete": true
        }
      ],
      "RowId": "6fb2d30d-89b6-4002-aabf-12a30d909838",
      "OrderId": "ce7a76e8-7546-44f7-9d0c-a7d339e08a89",
      "StockItemId": "fb055723-c88b-4d59-b399-ce2fcb17aa94"
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "02713a9f-8d53-4323-ba6d-3d8d97347df1",
      "OrderId": "14b46b11-5a44-4658-9d5e-1d0c157b0c0d",
      "NoteDate": "2022-03-09T13:04:14.2016903+00:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    }
  ],
  "PaidDateTime": "2022-03-09T13:04:14.2016903+00:00",
  "TaxId": "sample string 5"
}