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": "4a1b16cc-857d-4b36-a501-8f7e9a8f877f",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2019-11-28T09:46:01.5208698+00:00",
  "FulfilmentLocationId": "e5b22bd1-431c-4e7a-b65f-b56981e2cd72",
  "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": "26e874a6-acd6-409f-8898-d68ec18a4ac5",
        "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-11-28T09:46:01.5208698+00:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2019-11-28T09:46:01.5208698+00:00",
    "ScheduledDelivery": {
      "From": "2019-11-28T09:46:01.5208698+00:00",
      "To": "2019-11-28T09:46:01.5208698+00:00"
    },
    "HasScheduledDelivery": true,
    "Location": "91dd2ecc-e7ba-44b6-af36-ab488271bff5",
    "NumItems": 20,
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "36f77026-af0e-4264-ab2c-56f283719f51",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.1,
    "ItemWeight": 5.1,
    "PackageCategoryId": "8212b21b-8109-4002-8c97-5529dbaa2185",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "cf9706f4-e7fb-4051-83e8-baf447365f5f",
    "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": "26e35ade-d447-47a6-94e0-4e247c132156"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 1.1,
    "PostageCost": 2.1,
    "Tax": 3.1,
    "TotalCharge": 4.1,
    "PaymentMethod": "sample string 5",
    "PaymentMethodId": "65b66621-ba27-4d82-ad03-4bbf39817e65",
    "ProfitMargin": 7.1,
    "TotalDiscount": 8.1,
    "Currency": "sample string 9",
    "CountryTaxRate": 10.1,
    "ConversionRate": 11.1
  },
  "ExtendedProperties": [
    {
      "RowId": "fbeae0dc-348e-4c6f-b11b-b64f271148d5",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    },
    {
    }
  ],
  "FolderName": [
    "sample string 1",
    "sample string 2"
  ],
  "Items": [
    {
      "ItemId": "778941c6-50ce-4e3c-b705-09a77cfd97b5",
      "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": "0dc28907-3dec-4220-a973-ce5c4e07d156",
        "Rowid": "c166d9d5-74e6-4d72-a9e5-bb1ced3aaa53",
        "pkPurchaseId": "6339564d-a2c6-4137-be00-08bd5e8c0d84",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "07d0952b-6402-4f6d-8ba7-1f94f45760d0",
        "DateOfDelivery": "2019-11-28T09:46:01.5208698+00:00",
        "QuotedDeliveryDate": "2019-11-28T09:46:01.5208698+00:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "85403487-0eb9-42fa-9f1e-4a1f0bf448d5"
      },
      "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": "3bc777fa-b948-4960-864a-e70c99fa52b8",
      "AdditionalInfo": [
        {
          "pkOptionId": "75bd1a87-4fe4-4041-8855-743f05227c21",
          "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": "aee5f721-a75a-4f7b-85a4-59b3e8b8f3e2",
          "BatchId": 1,
          "OrderItemBatchId": 1
        },
        {
        }
      ],
      "InventoryTrackingType": 33,
      "isBatchedStockItem": false,
      "IsWarehouseManaged": true,
      "HasPurchaseOrders": true,
      "CanPurchaseOrderFulfil": true,
      "IsUnlinked": false,
      "RowId": "ff0802ad-76dc-4b81-89b5-c91479d4df54",
      "OrderId": "d5ec4688-2d31-4a06-8a16-b2f34f32b77a",
      "StockItemId": "d99eae4e-c57d-4449-ae82-0c58cb4305e4"
    },
    {
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "efee880d-8087-4715-bc95-b026a421dca5",
      "OrderId": "67a20e64-f415-4374-80c9-022fbe2c4dd6",
      "NoteDate": "2019-11-28T09:46:01.5208698+00:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    },
    {
    }
  ]
}