Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

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": "a2d20231-6fab-4749-a185-8cd203a92edd",
  "NumOrderId": 2,
  "Processed": true,
  "ProcessedDateTime": "2021-07-29T09:24:51.9064627+01:00",
  "FulfilmentLocationId": "62bfaf27-69c3-4b85-9e62-164893808bba",
  "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": "1c9e3eec-ca1c-47ef-822b-fea87574b1d5",
        "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": "2021-07-29T09:24:51.9064627+01:00",
    "Source": "sample string 14",
    "SubSource": "sample string 15",
    "SiteCode": "sample string 16",
    "HoldOrCancel": true,
    "DespatchByDate": "2021-07-29T09:24:51.9064627+01:00",
    "ScheduledDelivery": {
      "From": "2021-07-29T09:24:51.9064627+01:00",
      "To": "2021-07-29T09:24:51.9064627+01:00"
    },
    "HasScheduledDelivery": true,
    "Location": "7660c7b3-db6f-4d8a-91e3-3101c9d16283",
    "NumItems": 20,
    "PickwaveIds": [
      1
    ],
    "StockAllocationType": 0
  },
  "ShippingInfo": {
    "Vendor": "sample string 1",
    "PostalServiceId": "959605e7-2c66-49b6-872e-4966b23aea14",
    "PostalServiceName": "sample string 3",
    "TotalWeight": 4.0,
    "ItemWeight": 5.0,
    "PackageCategoryId": "78da9b62-80e9-457b-9e4a-fdb46a4be1af",
    "PackageCategory": "sample string 7",
    "PackageTypeId": "4be17a83-662e-4d35-9304-aa91beca01fd",
    "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": "ab51ecac-4ef0-461a-b4c3-bc5c8074107c"
    },
    "BillingAddress": {
    }
  },
  "TotalsInfo": {
    "Subtotal": 2.1,
    "PostageCost": 3.1,
    "Tax": 4.1,
    "TotalCharge": 5.1,
    "PaymentMethod": "sample string 6",
    "PaymentMethodId": "16e317aa-c72a-47a6-b85b-dc89b6181845",
    "ProfitMargin": 8.1,
    "TotalDiscount": 9.1,
    "Currency": "sample string 10",
    "CountryTaxRate": 11.1,
    "ConversionRate": 12.1
  },
  "ExtendedProperties": [
    {
      "RowId": "0d741dc3-28c8-4dd9-8218-b89a6f5cd6c7",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "FolderName": [
    "sample string 1"
  ],
  "Items": [
    {
      "ItemId": "1c97eb8f-396e-4d7a-ab7c-353218f6668e",
      "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": "1d8ec237-68fa-42c0-af5c-2138e8310487",
        "Rowid": "51ac3d75-b0fa-480b-9668-03a77650b309",
        "pkPurchaseId": "fd35cbbc-b34f-479e-9e0b-d7c1db49b058",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "bf6d5192-e0ee-441e-9014-b3af68806244",
        "DateOfDelivery": "2021-07-29T09:24:51.9064627+01:00",
        "QuotedDeliveryDate": "2021-07-29T09:24:51.9064627+01:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "9a57525a-9fdf-483e-8bdb-ab719b277b9e"
      },
      "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": "a5386ec1-2440-4438-96df-0246dd1c3b01",
      "AdditionalInfo": [
        {
          "pkOptionId": "1f582ac8-b4d8-49b3-aaac-0f24f7b0931c",
          "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": "8fbd0913-3b9b-4a5c-89ba-668ac676fef4",
          "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": "1b4889e6-e56e-4093-b766-12ea13536795",
          "LogicalDelete": true
        }
      ],
      "RowId": "6abcf172-dfed-413e-9bf5-89d1190ae669",
      "OrderId": "2bbcb7be-2e5b-4b51-b7d5-3d3470f121ff",
      "StockItemId": "9d50350a-f421-498b-b091-bd0f4846a43e"
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "4d999f1d-3906-43d1-b604-84a674ec8404",
      "OrderId": "c36089cf-e6b1-4d69-824f-a29a0f25743a",
      "NoteDate": "2021-07-29T09:24:51.9064627+01:00",
      "Internal": true,
      "Note": "sample string 5",
      "CreatedBy": "sample string 6",
      "NoteTypeId": 64
    }
  ],
  "PaidDateTime": "2021-07-29T09:24:51.9064627+01:00"
}