v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB

OpenOrders

GetOrdersLowFidelity

Returns low fidelity view of open orders. The data is generally useful for very basic view or counters of what is in the open orders. Useful for finding orders quickly as it returns all scannable fields of the order and order items such as order ids, skus, barcodes etc. Permissions Required: GlobalPermissions.OrderBook.DespatchConsoleNode Rate limit: 150 / minute

post/api/OpenOrders/GetOrdersLowFidelity

Request body

LocationIdstring uuid

(Optional) Fulfilment location id. Defaults to Default location

Example request

{
  "LocationId": "00000000-0000-0000-0000-000000000000"
}

Response

Example response

{
  "Orders": [
    {
      "Items": [
        {
          "CompositeChild": [
            {
              "StockItemId": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "StockItemId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "pkOrderID": "00000000-0000-0000-0000-000000000000"
    }
  ]
}