Back

Search

Search

Methods

Inventory

Orders

Orders /GetOrderDetailsByNumOrderId

Response: OrderDetails



Retrieves the order detail for a given order numeric id. If not found empty class is returned.

Parameters

NameTypeDescription
OrderIdInt32Order Id (numeric)

HTTP Endpoint

Server /Orders / GetOrderDetailsByNumOrderId

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

OrderId=1

Response

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

{
  "OrderId": "39f4abba-d944-4886-837a-53f8e93f8488",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2019-10-09T15:11:45.1222322+01:00",
  "FulfilmentLocationId": "5016bf51-84d1-488d-ac69-5113d60814b3",
  "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": "8c53aea3-1cce-4e1b-9205-c0a20d7be377",
        "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-10-09T15:11:45.1222322+01:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2019-10-09T15:11:45.1222322+01:00",
    "ScheduledDelivery": {
      "From": "2019-10-09T15:11:45.1222322+01:00",
      "To": "2019-10-09T15:11:45.1222322+01:00"
    },
    "HasScheduledDelivery": true,
    "Location": "5f0c5985-f5e8-491c-b45e-824ee6c7c3b2",
    "NumItems": 20,
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "556c6f71-579e-4c77-8179-b336ae0b707f",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.1,
    "ItemWeight": 5.1,
    "PackageCategoryId": "af4e68dd-a8da-4ac9-bc34-7e96df80f064",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "13a4ee68-6f27-4780-895a-c5609f8cf8be",
    "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": "3cf77823-3153-4c9c-b2fe-d85c9b93feac"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 1.1,
    "PostageCost": 2.1,
    "Tax": 3.1,
    "TotalCharge": 4.1,
    "PaymentMethod": "sample string 5",
    "PaymentMethodId": "7c8a61aa-c3ce-4706-bd1c-75a43f9ab629",
    "ProfitMargin": 7.1,
    "TotalDiscount": 8.1,
    "Currency": "sample string 9",
    "CountryTaxRate": 10.1,
    "ConversionRate": 11.1
  },
  "ExtendedProperties": [
    {
      "RowId": "b41df079-71ae-43b7-8f3e-c2c941e2a75c",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    },
    {
    }
  ],
  "FolderName": [
    "sample string 1",
    "sample string 2"
  ],
  "Items": [
    {
      "ItemId": "23b2dfe5-db83-4168-b6de-cbe84d4a8ab1",
      "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": "a96bddb0-f5e2-4c69-8c07-444ffb814365",
        "Rowid": "c7009f8e-7189-4561-9448-b57cf01df9e6",
        "pkPurchaseId": "24561caa-3432-4e08-9c6d-e4ec68fe1a83",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "2ded1215-5d4a-4bbf-96e6-21ec73a05807",
        "DateOfDelivery": "2019-10-09T15:11:45.1222322+01:00",
        "QuotedDeliveryDate": "2019-10-09T15:11:45.1222322+01:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "91159af8-ef8d-46c0-bc4b-6ebd4c2a224f"
      },
      "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": "558a4491-6a77-446e-96e9-f062cc555657",
      "AdditionalInfo": [
        {
          "pkOptionId": "eb475c71-a779-481d-8b33-322b9d435aa6",
          "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": "288fad7a-2308-4014-b035-2356ea0d2a64",
          "BatchId": 1,
          "OrderItemBatchId": 1
        },
        {
        }
      ],
      "InventoryTrackingType": 33,
      "isBatchedStockItem": false,
      "IsWarehouseManaged": true,
      "HasPurchaseOrders": true,
      "CanPurchaseOrderFulfil": true,
      "IsUnlinked": false,
      "RowId": "330bf9d7-0ab7-48f2-b6dc-a9e69ba5c2a1",
      "OrderId": "c7882777-cda4-46a3-a59d-86d6ce70d4b1",
      "StockItemId": "f3668f66-fd47-4478-973e-cec75984d2b6"
    },
    {
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "c1cb7a5e-d9ff-4d5d-b8a1-e70906a8f953",
      "OrderId": "1d38c024-d523-477c-bcea-8cec19f3d9e3",
      "NoteDate": "2019-10-09T15:11:45.1222322+01:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    },
    {
    }
  ]
}