Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Orders /GetOrderDetailsByReferenceId

Allows 250 calls per minute

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

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

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.

ReferenceId=sample string 1

Response

This is an example of the response JSON. Results will vary depending on your data.

[
  {
    "OrderId": "2e6257bd-b759-42e8-99fe-24d766dbddda",
    "NumOrderId": 2,
    "Processed": true,
    "ProcessedDateTime": "2021-07-29T09:24:51.8964616+01:00",
    "FulfilmentLocationId": "07420048-7d3f-4603-8c7c-9b5cbe1129c6",
    "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": "c3116424-0ce6-4834-89cf-985d39b4a18d",
          "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.8964616+01:00",
      "Source": "sample string 14",
      "SubSource": "sample string 15",
      "SiteCode": "sample string 16",
      "HoldOrCancel": true,
      "DespatchByDate": "2021-07-29T09:24:51.8964616+01:00",
      "ScheduledDelivery": {
        "From": "2021-07-29T09:24:51.8964616+01:00",
        "To": "2021-07-29T09:24:51.8964616+01:00"
      },
      "HasScheduledDelivery": true,
      "Location": "8954c2a3-5277-46ac-915a-ded244fda932",
      "NumItems": 20,
      "PickwaveIds": [
        1
      ],
      "StockAllocationType": 0
    },
    "ShippingInfo": {
      "Vendor": "sample string 1",
      "PostalServiceId": "42e6e572-443a-4f42-bba4-b46acc08b9e4",
      "PostalServiceName": "sample string 3",
      "TotalWeight": 4.0,
      "ItemWeight": 5.0,
      "PackageCategoryId": "f21cec58-4bba-4ace-b8f6-88288840dc6c",
      "PackageCategory": "sample string 7",
      "PackageTypeId": "480c5f55-bc12-46c0-ae71-fcbb730f1ed2",
      "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": "b05fe22d-922a-4975-ab07-1dc896738c0a"
      },
      "BillingAddress": {
      }
    },
    "TotalsInfo": {
      "Subtotal": 2.1,
      "PostageCost": 3.1,
      "Tax": 4.1,
      "TotalCharge": 5.1,
      "PaymentMethod": "sample string 6",
      "PaymentMethodId": "401ee00d-f869-42c4-917a-cd3dc8c6e993",
      "ProfitMargin": 8.1,
      "TotalDiscount": 9.1,
      "Currency": "sample string 10",
      "CountryTaxRate": 11.1,
      "ConversionRate": 12.1
    },
    "ExtendedProperties": [
      {
        "RowId": "0801ae14-dd94-41d9-ae03-c887f61ea8b3",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "Type": "sample string 4"
      }
    ],
    "FolderName": [
      "sample string 1"
    ],
    "Items": [
      {
        "ItemId": "3e7202f9-9c49-4b34-8698-8111b27f0dc4",
        "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": "57a690f7-3427-4c2e-9e17-663914f8209e",
          "Rowid": "fde7456d-f55d-4c18-9748-5b1a7eac68bb",
          "pkPurchaseId": "37a47dac-6c5b-4acc-8264-e28e0fe5436d",
          "ExternalInvoiceNumber": "sample string 4",
          "fkSupplierId": "3175094c-2c30-426a-a3e4-f57a3bce5fde",
          "DateOfDelivery": "2021-07-29T09:24:51.8974611+01:00",
          "QuotedDeliveryDate": "2021-07-29T09:24:51.8974611+01:00",
          "SupplierName": "sample string 8",
          "fkLocationId": "427185bd-fbcc-4006-a95d-314b43e6b0db"
        },
        "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": "42b63c8c-bc6d-4695-8af1-0c52f6ade2df",
        "AdditionalInfo": [
          {
            "pkOptionId": "902df73c-a6a1-4ade-adf3-08377cc88c1a",
            "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": "315c8b63-3978-4448-9694-4bcc96d2c62a",
            "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": "5e48bfbe-d77e-4c3f-a884-f06ca92f77a6",
            "LogicalDelete": true
          }
        ],
        "RowId": "cc73ed85-69a3-45dd-8794-09bb1d62b27f",
        "OrderId": "3c059012-709c-4bf5-9935-78ff07d63954",
        "StockItemId": "f8ddc3c8-92ca-4cd7-bde1-59f3e1765262"
      }
    ],
    "Notes": [
      {
        "OrderNoteId": "8963f6f3-d308-42b2-bf49-1f506daa846c",
        "OrderId": "5c9df47e-138c-4749-be7c-25ea809dda02",
        "NoteDate": "2021-07-29T09:24:51.8974611+01:00",
        "Internal": true,
        "Note": "sample string 5",
        "CreatedBy": "sample string 6",
        "NoteTypeId": 64
      }
    ],
    "PaidDateTime": "2021-07-29T09:24:51.8974611+01:00"
  }
]