GET pickwaves?AssignedUserId={AssignedUserId}&Page={Page}&PageSize={PageSize}&Status={Status}&WarehouseId={WarehouseId}

Returns a page of Pickwave records based upon the supplied filter

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AssignedUserId This is an optional parameter. Set this to get Pickwaves for a given assigned user Id. integer Matching regular expression pattern: ^[1-9]\d*$
Page This is an optional parameter. It will default to page 1. integer Matching regular expression pattern: ^[1-9]\d*$
PageSize This is an optional parameter. This will default to 100. The max page size is 100. integer Range: inclusive between 1 and 100
Status This is an optional parameter. Set it to only return orders for a given status. BatchStatuses Matching regular expression pattern: ^(Completed|Open|1|2)$
WarehouseId This is an optional parameter. Set it to only return orders for a given warehouse. You can get a list of warehouses from the warehouses endpoint. integer Matching regular expression pattern: ^[1-9]\d*$

Body Parameters

None.

Response Information

Resource Description

Returns a page of Pickwave records based upon the supplied filter

PagedResponseModelOfPickwaveModel
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
Data Collection of PickwaveModel None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalItems": 1,
  "PagingInfo": {
    "PageSize": 1,
    "Page": 2
  },
  "TotalPages": 2,
  "Data": [
    {
      "PickwaveID": 1,
      "AssignedOnUTC": "2024-11-21T10:00:10.4071977+00:00",
      "AssignedUserID": 1,
      "DespatchedOrderCount": 2,
      "PickedOnUTC": "2024-11-21T10:00:10.409619+00:00",
      "PickerID": 1,
      "StartedOnUTC": "2024-11-21T10:00:10.4105695+00:00",
      "Status": "sample string 3",
      "Tag": "sample string 4",
      "TotalOrderCount": 5,
      "WarehouseID": 6
    },
    {
      "PickwaveID": 1,
      "AssignedOnUTC": "2024-11-21T10:00:10.4071977+00:00",
      "AssignedUserID": 1,
      "DespatchedOrderCount": 2,
      "PickedOnUTC": "2024-11-21T10:00:10.409619+00:00",
      "PickerID": 1,
      "StartedOnUTC": "2024-11-21T10:00:10.4105695+00:00",
      "Status": "sample string 3",
      "Tag": "sample string 4",
      "TotalOrderCount": 5,
      "WarehouseID": 6
    }
  ]
}

application/xml, text/xml

Sample: 
<PagedResponseModelOfPickwaveModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>1</TotalItems>
  <PagingInfo>
    <PageSize>1</PageSize>
    <Page>2</Page>
  </PagingInfo>
  <TotalPages>2</TotalPages>
  <Data>
    <PickwaveModel>
      <PickwaveId>1</PickwaveId>
      <AssignedOnUtc>2024-11-21T10:00:10.4071977+00:00</AssignedOnUtc>
      <AssignedUserId>1</AssignedUserId>
      <DespatchedOrderCount>2</DespatchedOrderCount>
      <PickedOnUtc>2024-11-21T10:00:10.409619+00:00</PickedOnUtc>
      <PickerId>1</PickerId>
      <StartedOnUtc>2024-11-21T10:00:10.4105695+00:00</StartedOnUtc>
      <Status>sample string 3</Status>
      <Tag>sample string 4</Tag>
      <TotalOrderCount>5</TotalOrderCount>
      <WarehouseId>6</WarehouseId>
    </PickwaveModel>
    <PickwaveModel>
      <PickwaveId>1</PickwaveId>
      <AssignedOnUtc>2024-11-21T10:00:10.4071977+00:00</AssignedOnUtc>
      <AssignedUserId>1</AssignedUserId>
      <DespatchedOrderCount>2</DespatchedOrderCount>
      <PickedOnUtc>2024-11-21T10:00:10.409619+00:00</PickedOnUtc>
      <PickerId>1</PickerId>
      <StartedOnUtc>2024-11-21T10:00:10.4105695+00:00</StartedOnUtc>
      <Status>sample string 3</Status>
      <Tag>sample string 4</Tag>
      <TotalOrderCount>5</TotalOrderCount>
      <WarehouseId>6</WarehouseId>
    </PickwaveModel>
  </Data>
</PagedResponseModelOfPickwaveModel>