LIlinnworks
Orders

GetOrder

Get a specific open order <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

post/api/Orders/GetOrder

Request

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

Request body

orderIdstring uuid

Order id

fulfilmentLocationIdstring uuid

Current fulfilment center

loadItemsboolean

Load or not the order items information

loadAdditionalInfoboolean

Load or not the order additional info

Example request

{
  "orderId": "00000000-0000-0000-0000-000000000000",
  "fulfilmentLocationId": "00000000-0000-0000-0000-000000000000"
}

Response

OK

NumOrderIdinteger

Linnworks order number

FolderNamestring[]

Folder name of an order if any assigned

IsPostFilteredOutboolean
CanFulfilboolean
HasItemsboolean
TotalItemsSuminteger
OrderIdstring uuid

Order ID (pkOrderID)

Example response

{
  "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"
  },
  "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"
    }
  ],
  "OrderId": "00000000-0000-0000-0000-000000000000"
}

Changes

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