LIlinnworks
OpenOrders

GetOpenOrdersDetails

Open order details by order ids. Not limited by the number of orders you can retrieve. This call is designed to return ONLY open orders, it is much faster than GetOrderDetail call <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

post/api/OpenOrders/GetOpenOrdersDetails

Request

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

Request body

OrderIdsstring[]

List of order ids as unique identifiers

DetailLevelstring[]

(optional) List of detail level limiters. If the list is null or empty Full details will be returned, as in all detail levels are applied

Example request

{
  "OrderIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Response

OK

Example response

{
  "Orders": [
    {
      "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.