Back

Search

Search

Methods

Inventory

Orders

Picking /GetPickwaveUsersWithSummary

Allows 150 calls per minute

Response: GetPickwaveUsersWithSummaryResponse



Returns a list of pickwaves as well as dummy entries for users who have permissions to complete pickwaves, but don't currently have any assigned. These entries will have a PickwaveId of 0.

Parameters

NameTypeDescription
requestGetPickingWavesRequest

Permissions

GlobalPermissions.OrderBook.OpenOrders.PickingWaves.GeneratePickingWavesNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Picking/GetPickwaveUsersWithSummary

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "State": 0,
  "LocationId": "9fa61042-60a0-4ae7-aed5-e6aa987bfc34",
  "DetailLevel": "All"
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "PickingWaves": [
    {
      "LocationId": "58656291-c4fd-44ec-a6ae-04574947e6b9",
      "UserId": 1,
      "EmailAddress": "sample string 2",
      "CreatedDate": "2021-03-19T09:31:27.4028058+00:00",
      "OrderCount": 4,
      "ItemCount": 5,
      "ItemsPicked": 6,
      "OrdersPicked": 7,
      "AccumulatedInProgressSeconds": 8,
      "StartTime": "2021-03-19T09:31:27.4028058+00:00",
      "EndTime": "2021-03-19T09:31:27.4028058+00:00",
      "GroupType": "Items",
      "Orders": [
        {
          "PickingWaveOrdersRowId": 1,
          "PickingWaveId": 2,
          "OrderId": 3,
          "PickState": "Unpicked",
          "SortOrder": 4,
          "ItemCount": 5,
          "PickedItemsCount": 6,
          "Items": [
            {
              "PickingWaveItemsRowId": 1,
              "PickingWaveId": 2,
              "PickedQuantity": 3,
              "TotBarcode": "sample string 4",
              "SortOrder": 5,
              "ToPickQuantity": 6,
              "TOTId": 1,
              "TrayTag": "sample string 7",
              "PickingTag": "sample string 8",
              "ItemState": 0,
              "BatchInventoryId": 1,
              "OrderId": 9,
              "OrderItemRowId": "4be66193-5914-40df-baee-4c7630a54de9",
              "StockItemId": "5b220208-23fd-4fdd-b705-1c27417e4430"
            }
          ]
        }
      ],
      "Options": {
        "ItemScanType": "Any",
        "TrayScanRequired": true,
        "TotScanRequired": true,
        "BinRackScanRequired": true
      },
      "PickingWaveId": 9,
      "State": "Unallocated"
    }
  ]
}