GET api/v2/workorders

Get all the workorders

Request Information

URI Parameters

Name Type Description Additional information
pageNumber integer

Default value is 1

pageSize integer

Default value is 10

workOrderNumber string

status KittingWorkOrderStatus

Body Parameters

None

Response Information

Resource Description

WorkOrdersPagedResponse
Name Type Description Additional information
TotalPages integer

TotalResultsCount integer

NextPageNumber integer

Results Collection of WorkOrderDto

Response Formats

application/json, text/json

Sample:
{
  "TotalPages": 1,
  "TotalResultsCount": 2,
  "NextPageNumber": 1,
  "Results": [
    {
      "WorkOrderId": 1,
      "WorkOrderNumber": "sample string 2",
      "Kit": {
        "Name": "sample string 1",
        "Sku": "sample string 2"
      },
      "QuantityToBuild": 3,
      "CreatedAt": "sample string 4",
      "Status": "sample string 5",
      "RequestedDate": "sample string 6",
      "CompletionDate": "sample string 7",
      "WarehouseReference": "sample string 8",
      "LotNumber": "sample string 9",
      "ExpirationDate": "sample string 10"
    },
    {
      "WorkOrderId": 1,
      "WorkOrderNumber": "sample string 2",
      "Kit": {
        "Name": "sample string 1",
        "Sku": "sample string 2"
      },
      "QuantityToBuild": 3,
      "CreatedAt": "sample string 4",
      "Status": "sample string 5",
      "RequestedDate": "sample string 6",
      "CompletionDate": "sample string 7",
      "WarehouseReference": "sample string 8",
      "LotNumber": "sample string 9",
      "ExpirationDate": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:
<WorkOrdersPagedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.WorkOrdersService.Models">
  <NextPageNumber>1</NextPageNumber>
  <Results>
    <WorkOrderDto>
      <CompletionDate>sample string 7</CompletionDate>
      <CreatedAt>sample string 4</CreatedAt>
      <ExpirationDate>sample string 10</ExpirationDate>
      <Kit>
        <Name>sample string 1</Name>
        <Sku>sample string 2</Sku>
      </Kit>
      <LotNumber>sample string 9</LotNumber>
      <QuantityToBuild>3</QuantityToBuild>
      <RequestedDate>sample string 6</RequestedDate>
      <Status>sample string 5</Status>
      <WarehouseReference>sample string 8</WarehouseReference>
      <WorkOrderId>1</WorkOrderId>
      <WorkOrderNumber>sample string 2</WorkOrderNumber>
    </WorkOrderDto>
    <WorkOrderDto>
      <CompletionDate>sample string 7</CompletionDate>
      <CreatedAt>sample string 4</CreatedAt>
      <ExpirationDate>sample string 10</ExpirationDate>
      <Kit>
        <Name>sample string 1</Name>
        <Sku>sample string 2</Sku>
      </Kit>
      <LotNumber>sample string 9</LotNumber>
      <QuantityToBuild>3</QuantityToBuild>
      <RequestedDate>sample string 6</RequestedDate>
      <Status>sample string 5</Status>
      <WarehouseReference>sample string 8</WarehouseReference>
      <WorkOrderId>1</WorkOrderId>
      <WorkOrderNumber>sample string 2</WorkOrderNumber>
    </WorkOrderDto>
  </Results>
  <TotalPages>1</TotalPages>
  <TotalResultsCount>2</TotalResultsCount>
</WorkOrdersPagedResponse>