GET v1/printer/list

Retrieve list of Printers with minimal information

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

PrinterModel
NameDescriptionTypeAdditional information
PrinterID

integer

None.

PrinterName

string

None.

Location

LocationModel

None.

DPI

integer

None.

VerticalShift

decimal number

None.

HorizontalShift

decimal number

None.

IPAddress

string

None.

Port

string

None.

TearOffPosition

decimal number

None.

PrinterMedia

PrinterMediaModel

None.

IsDirectThermalMediaType

boolean

None.

SlewSpeed

integer

None.

PrintSpeed

integer

None.

BackFeedSpeed

integer

None.

Darkness

integer

None.

PostPrintAction

PostPrintActionModel

None.

MirrorHorizontally

boolean

None.

MirrorVertically

boolean

None.

PrepeelLabel

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "printerID": 1,
  "printerName": "sample string 2",
  "location": {
    "locationID": 1,
    "company": {
      "companyID": 1,
      "companyName": "sample string 2",
      "companyCode": "sample string 3",
      "vatNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "address4": "sample string 8",
      "address5": "sample string 9",
      "email": "sample string 10",
      "currentRates": [
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:21:22.4816859+00:00"
        },
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:21:22.4816859+00:00"
        }
      ]
    },
    "isActive": true,
    "isKeyAccount": true,
    "locationCategory": {
      "locationCategoryID": 1,
      "locationCategory": "sample string 2",
      "isSystem": true
    },
    "locationName": "sample string 4",
    "address": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "city": "sample string 8",
    "state": {
      "stateID": 1,
      "stateShortName": "sample string 2",
      "stateLongName": "sample string 3"
    },
    "zipCode": "sample string 9",
    "country": {
      "countryID": 1,
      "countryShortName": "sample string 2",
      "countryLongName": "sample string 3"
    },
    "cityStateZipCountry": "sample string 10",
    "xCoordinate": "sample string 11",
    "yCoordinate": "sample string 12",
    "googlePlaceID": "sample string 13",
    "googleURL": "sample string 14",
    "term": {
      "termID": 1,
      "term": "sample string 2",
      "isActive": true
    },
    "bolTemplate": {
      "bolTemplateID": 1,
      "templateName": "sample string 2"
    },
    "isIntegrationControlled": true,
    "locationRules": {
      "locationRuleID": 1,
      "shipMethod": {
        "shipMethodID": 1,
        "shipMethod": "sample string 2"
      },
      "isLocked": true,
      "canSelfOrder": true,
      "additionalBillingDays": 4,
      "allowUDFAddress": true,
      "palletLabelQuantity": 6,
      "returnFlagType": {
        "flagTypeID": 1,
        "flagType": "sample string 2",
        "isActive": true,
        "isSystem": true,
        "isCleared": true,
        "isDefault": true,
        "isRepair": true,
        "isAdmin": true,
        "isRepairComponent": true
      },
      "returnFlagBarcodePrefix": "sample string 7"
    }
  },
  "dpi": 3,
  "verticalShift": 4.0,
  "horizontalShift": 5.0,
  "ipAddress": "sample string 6",
  "port": "sample string 7",
  "tearOffPosition": 8.0,
  "printerMedia": {
    "printerMediaID": 1,
    "printerMedia": "sample string 2"
  },
  "isDirectThermalMediaType": true,
  "slewSpeed": 10,
  "printSpeed": 11,
  "backFeedSpeed": 12,
  "darkness": 13,
  "postPrintAction": {
    "postPrintActionID": 1,
    "postPrintAction": "sample string 2"
  },
  "mirrorHorizontally": true,
  "mirrorVertically": true,
  "prepeelLabel": true
}