LIlinnworks
Orders

GetOrderById

Retrieves the order detail for a unique system order id identifier (pkOrderId) For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails <b>Permissions Required: </b> GlobalPermissions.OrderBook.ViewOrderDetailsNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

get/api/Orders/GetOrderById

Request

  • Base URL
    https://eu-ext.linnworks.net
  • URL
    https://eu-ext.linnworks.net/api/Orders/GetOrderById
  • Auth
    API key in header Authorization

Query parameters

pkOrderIdstring uuid

pkOrderId

Response

OK

OrderIdstring uuid

Order ID (pkOrderId)

NumOrderIdinteger

Linnworks order number

Processedboolean

If order is processed

ProcessedDateTimestring date-time

Date and time when order was processed

FulfilmentLocationIdstring uuid

Location ID

FolderNamestring[]

Folder names assigned to an order

PaidDateTimestring date-time

Date and time when the order was marked as paid

TaxIdstring

Buyer's tax number.

Example response

{
  "OrderId": "00000000-0000-0000-0000-000000000000",
  "FulfilmentLocationId": "00000000-0000-0000-0000-000000000000",
  "GeneralInfo": {
    "Identifiers": [
      {
        "ImageId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "Location": "00000000-0000-0000-0000-000000000000"
  },
  "ShippingInfo": {
    "PostalServiceId": "00000000-0000-0000-0000-000000000000",
    "PackageCategoryId": "00000000-0000-0000-0000-000000000000",
    "PackageTypeId": "00000000-0000-0000-0000-000000000000"
  },
  "CustomerInfo": {
    "Address": {
      "CountryId": "00000000-0000-0000-0000-000000000000"
    },
    "BillingAddress": {
      "CountryId": "00000000-0000-0000-0000-000000000000"
    }
  },
  "TotalsInfo": {
    "PaymentMethodId": "00000000-0000-0000-0000-000000000000"
  },
  "ExtendedProperties": [
    {
      "RowId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "Items": [
    {
      "ItemId": "00000000-0000-0000-0000-000000000000",
      "OnPurchaseOrder": {
        "pkPurchaseItemId": "00000000-0000-0000-0000-000000000000",
        "Rowid": "00000000-0000-0000-0000-000000000000",
        "pkPurchaseId": "00000000-0000-0000-0000-000000000000",
        "fkSupplierId": "00000000-0000-0000-0000-000000000000",
        "fkLocationId": "00000000-0000-0000-0000-000000000000"
      },
      "ImageId": "00000000-0000-0000-0000-000000000000",
      "AdditionalInfo": [
        {
          "pkOptionId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "BinRacks": [
        {
          "Location": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "Boxes": [
        {
          "PackagingTypeId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "RowId": "00000000-0000-0000-0000-000000000000",
      "OrderId": "00000000-0000-0000-0000-000000000000",
      "StockItemId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "Notes": [
    {
      "OrderNoteId": "00000000-0000-0000-0000-000000000000",
      "OrderId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.