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": "5829977a-718b-4612-a294-f7f009e622c7",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2022-09-05T15:10:05.3993638+03:00",
  "FulfilmentLocationId": "d463f41a-e5a9-4b87-b8a9-733e72ae0504",
  "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": "df67c89b-2be9-4140-bce5-9274a625d7a5",
        "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.3993638+03:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2022-09-05T15:10:05.3993638+03:00",
    "ScheduledDelivery": {
      "From": "2022-09-05T15:10:05.3993638+03:00",
      "To": "2022-09-05T15:10:05.3993638+03:00"
    },
    "HasScheduledDelivery": true,
    "Location": "5cf0b0f7-aa0e-4c07-983c-4f10c997d44b",
    "NumItems": 20,
    "PickwaveIds": [
      1
    ],
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "5d6aa6e9-40c9-46b0-b06e-3bef9fc65278",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.0,
    "ItemWeight": 5.0,
    "PackageCategoryId": "325a75a0-dc05-44eb-b512-e9ef1c602780",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "9b14451c-5927-4fbc-8f04-9e0a2c098697",
    "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": "4edace05-afa4-421e-a0d3-1bc761deb287"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 2.1,
    "PostageCost": 3.1,
    "PostageCostExTax": 4.1,
    "Tax": 5.1,
    "TotalCharge": 6.1,
    "PaymentMethod": "sample string 7",
    "PaymentMethodId": "6c9fcd38-8122-4cdd-ab83-9fd9695f851f",
    "ProfitMargin": 9.1,
    "TotalDiscount": 10.1,
    "Currency": "sample string 11",
    "CountryTaxRate": 12.1,
    "ConversionRate": 13.1
  },
  "ExtendedProperties": [
    {
      "RowId": "26d30873-6815-4ab8-bb42-a834c44b3123",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "FolderName": [
    "sample string 1"
  ],
  "Items": [
    {
      "ItemId": "14e2b41c-6259-4915-8858-541efd61d4ad",
      "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": "053898b1-5067-483a-aeb2-8be33a3a6ed8",
        "Rowid": "3cf75b16-757e-43b4-9766-da7191c05bf7",
        "pkPurchaseId": "ee963b23-177d-4808-9d41-ee092e7cb52f",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "adf3f0d5-a0cf-4e66-816a-bd372624026b",
        "DateOfDelivery": "2022-09-05T15:10:05.3993638+03:00",
        "QuotedDeliveryDate": "2022-09-05T15:10:05.3993638+03:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "9e15f810-b10e-442d-ae7f-d64502a8b736"
      },
      "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": "4256031d-c30b-44f4-8871-56c50e122a58",
      "AdditionalInfo": [
        {
          "pkOptionId": "749a3e8a-873d-41bd-ad7d-98a4be749ad7",
          "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": "964763eb-49f6-4da4-8968-cebb4026e938",
          "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": "0f86a6f6-13ee-4a11-8067-278a56da0414",
          "LogicalDelete": true
        }
      ],
      "RowId": "cc5fdcb6-81e1-45e8-982b-38d0470b7cf2",
      "OrderId": "b3bac836-3938-4ce2-9227-b263077a12af",
      "StockItemId": "5c91e8d6-b5db-468b-8bd5-a440b5bbd12b"
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "fc369fd9-bb18-4efe-88c4-3322aaa0b903",
      "OrderId": "daf15a9c-8037-4e72-aa8e-49a0ba575655",
      "NoteDate": "2022-09-05T15:10:05.3993638+03:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    }
  ],
  "PaidDateTime": "2022-09-05T15:10:05.3993638+03:00",
  "TaxId": "sample string 5"
}