Back

Search

Search

Methods

Inventory

Orders

Orders /GetOrderDetailsByReferenceId

Response: List<OrderDetails>



Retrieves a list of order details for a given order reference number, returns maximum of 50 orders.
For eBay orders, if Sellling Manager Pro sales number is available the order can be retrived by this number

Parameters

NameTypeDescription
ReferenceIdStringOrder reference id, or SecondaryReferenceNumber

HTTP Endpoint

Server /Orders / GetOrderDetailsByReferenceId

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

ReferenceId=sample string 1

Response

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

[
  {
    "OrderId": "21a79f4f-a7a1-4da6-88b5-062a7f5cee9f",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2018-10-03T11:12:36.3688261+01:00",
    "FulfilmentLocationId": "85c5c2d7-c6bc-4a32-b7b6-a3351af64f75",
    "GeneralInfo": {
      "Status": 1,
      "LabelPrinted": true,
      "LabelError": "sample string 3",
      "InvoicePrinted": true,
      "PickListPrinted": true,
      "IsRuleRun": true,
      "Notes": 7,
      "PartShipped": true,
      "Marker": 64,
      "IsParked": true,
      "Identifiers": null,
      "ReferenceNum": "sample string 10",
      "SecondaryReference": "sample string 11",
      "ExternalReferenceNum": "sample string 12",
      "ReceivedDate": "2018-10-03T11:12:36.3688261+01:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2018-10-03T11:12:36.3688261+01:00",
      "ScheduledDelivery": {
        "From": "2018-10-03T11:12:36.3688261+01:00",
        "To": "2018-10-03T11:12:36.3688261+01:00"
      },
      "HasScheduledDelivery": true,
      "Location": "3eef653a-1b9e-4e11-8385-f317c6257fe0",
      "NumItems": 20,
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "233cc8be-fa65-4f8c-b7b6-a81069815b7b",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.1,
      "ItemWeight": 5.1,
      "PackageCategoryId": "fe27f19a-68c6-4cb3-ac64-71490110b832",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "8a18c817-1f67-4bc6-aab8-60b0f8b20a20",
      "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": "e91a789a-771e-4d52-abaf-29bbb6885d90"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 1.1,
      "PostageCost": 2.1,
      "Tax": 3.1,
      "TotalCharge": 4.1,
      "PaymentMethod": "sample string 5",
      "PaymentMethodId": "5b6e2ebe-3516-4961-b109-99324236fb63",
      "ProfitMargin": 7.1,
      "TotalDiscount": 8.1,
      "Currency": "sample string 9",
      "CountryTaxRate": 10.1,
      "ConversionRate": 11.1
    },
    "ExtendedProperties": [
      {
        "RowId": "297513b0-565c-47f4-a1ff-643091f698c8",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      },
      {
      }
    ],
    "FolderName": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ItemId": "df8914cf-bca8-4cf7-9e59-1f20441618b0",
        "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,
        "InOrderBook": 1,
        "Level": 11,
        "MinimumLevel": 1,
        "AvailableStock": 12,
        "PricePerUnit": 13.1,
        "UnitCost": 14.1,
        "Discount": 15.1,
        "Tax": 20.1,
        "TaxRate": 16.1,
        "Cost": 17.1,
        "CostIncTax": 18.1,
        "CompositeSubItems": [
          {
          },
          {
          }
        ],
        "IsService": true,
        "SalesTax": 20.1,
        "TaxCostInclusive": true,
        "PartShipped": true,
        "Weight": 23.1,
        "BarcodeNumber": "sample string 24",
        "Market": 25,
        "ChannelSKU": "sample string 26",
        "ChannelTitle": "sample string 27",
        "DiscountValue": 10.222739018087856,
        "HasImage": true,
        "ImageId": "5ebd2fa1-780b-4758-a9d4-e6716ef61994",
        "AdditionalInfo": [
          {
            "pkOptionId": "92baadcf-c1fc-493f-893f-54ccfab300cf",
            "Property": "sample string 2",
            "Value": "sample string 3"
          },
          {
          }
        ],
        "StockLevelIndicator": 28,
        "BatchNumberScanRequired": true,
        "SerialNumberScanRequired": true,
        "BinRack": "sample string 31",
        "BinRacks": [
          {
            "Quantity": 1,
            "BinRack": "sample string 2",
            "Location": "c9ab367f-d34c-4e7d-b300-aeb5437f5fa7",
            "BatchId": 1,
            "OrderItemBatchId": 1
          },
          {
          }
        ],
        "InventoryTrackingType": 32,
        "isBatchedStockItem": false,
        "HasPurchaseOrders": true,
        "CanPurchaseOrderFulfil": true,
        "IsUnlinked": false,
        "RowId": "b6f1d3d2-77f3-484f-9e21-5b0fd454f08a",
        "OrderId": "63556cff-2e9b-44ac-a9c3-b98b8080a8bc",
        "StockItemId": "f0a432d5-8b99-48e5-a533-088902d282d8"
      },
      {
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "d1c5731a-a1c5-4c68-8be2-0f3c174e0770",
        "OrderId": "32f9c1cd-8da9-4b63-81e1-e2473c36ecb9",
        "NoteDate": "2018-10-03T11:12:36.3688261+01:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      },
      {
      }
    ]
  },
  {
  }
]