GET api/externalpicking/printers?warehouse={warehouse}

Get available printers

Request Information

URI Parameters

NameDescriptionTypeAdditional information
warehouse

Optional parameter, to filter printers by warehouse

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PrinterInfo
NameDescriptionTypeAdditional information
DeviceId

System-generated printer identfier, such as 3452124, which is unique key for printers.

integer

None.

DisplayName

Printer display name, such as "PRN123LBL9"

string

None.

ShortAlias

Short name for voice picking or similar applications, where it is incovenient to use printer display name. Not constrained to be unique, so handle possible duplicates. In practice may be used as a key locally. Example: "P1"

string

None.

PhysicalLocationDescription

Describes the physical location, such as street address and floor or similar

string

None.

Warehouse

Associates printers with warehouses.

string

None.

PrintLayoyts

Available print layouts

Collection of string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PrintLayoyts": [
      "sample string 1",
      "sample string 2"
    ],
    "DeviceId": 1,
    "DisplayName": "sample string 2",
    "ShortAlias": "sample string 3",
    "PhysicalLocationDescription": "sample string 4",
    "Warehouse": "sample string 5"
  },
  {
    "PrintLayoyts": [
      "sample string 1",
      "sample string 2"
    ],
    "DeviceId": 1,
    "DisplayName": "sample string 2",
    "ShortAlias": "sample string 3",
    "PhysicalLocationDescription": "sample string 4",
    "Warehouse": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPrinterInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WMS.WebApiService.DTOs">
  <PrinterInfo>
    <DisplayName>sample string 2</DisplayName>
    <PhysicalLocationDescription>sample string 4</PhysicalLocationDescription>
    <PrintLayoyts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PrintLayoyts>
    <ShortAlias>sample string 3</ShortAlias>
    <Warehouse>sample string 5</Warehouse>
  </PrinterInfo>
  <PrinterInfo>
    <DisplayName>sample string 2</DisplayName>
    <PhysicalLocationDescription>sample string 4</PhysicalLocationDescription>
    <PrintLayoyts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PrintLayoyts>
    <ShortAlias>sample string 3</ShortAlias>
    <Warehouse>sample string 5</Warehouse>
  </PrinterInfo>
</ArrayOfPrinterInfo>