---
title: "GetAllPickingWaveHeaders"
method: GET
path: "/api/Picking/GetAllPickingWaveHeaders"
tags: ["Picking"]
---

# GetAllPickingWaveHeaders

`GET /api/Picking/GetAllPickingWaveHeaders`

## Request

- Base URL: `https://eu-ext.linnworks.net`
- URL: `https://eu-ext.linnworks.net/api/Picking/GetAllPickingWaveHeaders`
- Auth: API key in header `Authorization`

Get a list of all pickwaves
<b>Permissions Required: </b> GlobalPermissions.OrderBook.OpenOrders.PickingWaves.AllPickingWavesNode
<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

## Query parameters

- `state` 'Unallocated' | 'Allocated' | 'InProgress' | 'Paused' | 'Complete' | 'Abandoned' | 'Packing' | 'Shipped'
- `locationId` string, uuid
- `detailLevel` 'All' | 'OnlyPickWave'

## Response `200`

OK

- GetPickingWaveHeadersResponse
  - `PickwaveHeaders` PickingWave[]: List of pickingwave headers without order details
    - `LocationId` string, uuid: Location Id
    - `UserId` integer: Allocated user id
    - `EmailAddress` string: Allocated user EmailAddress
    - `CreatedDate` string, date-time: Creation date
    - `OrderCount` integer: Order Count - Number of orders in pickwave.
    - `ItemCount` integer: Item Count - Number of items in pickwave.
    - `ItemsPicked` integer: Items Picked - Number of items picked in pickwave.
    - `OrdersPicked` integer: Orders Picked - Number of orders picked in pickwave.
    - `AccumulatedInProgressSeconds` integer: Time taken in pickwave
    - `StartTime` string, date-time: Start date time of pickwave
    - `EndTime` string, date-time: End date time of pickwave
    - `GroupType` 'Items' | 'Orders': Pickwave group type
    - `SortType` 'BinPriority' | 'OrderView'
    - `Orders` PickingWaveOrder[]: Orders in pickwave. This data is not returned if just headers are requested.
      - `PickingWaveOrdersRowId` integer: Pickwave order id
      - `PickingWaveId` integer: Pickwave id
      - `OrderId` integer: Order Id
      - `PickState` 'Unpicked' | 'PartialPicked' | 'Picked' | 'Processed' | 'LockedOrParked' | 'Cancelled' | 'Deleted': Pick state
      - `SortOrder` integer: Sort order
      - `ItemCount` integer: Items count
      - `PickedItemsCount` integer: Picked items count
      - `Items` PickingWaveItem[]: Pickwave order items.
        - `PickingWaveItemsRowId` integer: Pickwave item row id
        - `PickingWaveId` integer: Pickwave id
        - `PickedQuantity` integer: Quatity picked
        - `TotBarcode` string: Tote Barcode
        - `SortOrder` integer: Sort order
        - `ToPickQuantity` integer: Quantity to pick
        - `TOTId` integer: ToT Id
        - `TrayTag` string: Tray tag
        - `PickingTag` string: Picking tag
        - `ItemState` 'Normal' | 'OrderStateInvalid' | 'Abandonned' | 'DeletedFromOrder'
        - `BatchInventoryId` integer: Batch Inventory Id
        - `OrderId` integer: Linnworks Order Id
        - `OrderItemRowId` string, uuid: Unique order item row identifier
        - `StockItemId` string, uuid: StockItemId
        - `OrderSortOrder` integer: Sort order of Order
    - `Options` PickingWaveOptions
      - `ItemScanType` 'Any' | 'IndividualItem' | 'AggregateItem': Item scan type, dictates if the user must scan all items or can provide aggregate count
      - `TrayScanRequired` boolean: If the user must scan the tray the item went into.
      - `TotScanRequired` boolean: If the user must scan the tot before scanning items.
      - `BinRackScanRequired` boolean: If the user must scan the binrack before picking an item.
    - `PickingWaveId` integer: Pickwave id
    - `State` 'Unallocated' | 'Allocated' | 'InProgress' | 'Paused' | 'Complete' | 'Abandoned' | 'Packing' | 'Shipped': Current state of pickwave

---

[API](https://skmtc.dev/linnworks/apis/picking-api.md) - [All operations](https://skmtc.dev/linnworks/apis/picking-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/picking-api/revisions/0afe90b3e5b1?raw)