Create printer

Supported protocols in the printer path are lpd,jd and flowbox. E.g. lpd://192.168.1.4/queuename or jd://192.168.11.2:9100/ or flowbox://flowboxUid/flowboxPeripheralUid.

Required permissions: PRINTER

post

/tenants/{tenantUid}/printers

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

printerUidstringOptionalPattern: ^[A-Za-z0-9-_]*

typestring · enumRequiredPossible values:

pathstringRequired

storeUidstring · nullableOptionalPattern: ^[A-Za-z0-9-_]*

namestringOptional

descriptionstringOptional

Responses

201

Example response

application/json

printerUidstringRequiredPattern: ^[A-Za-z0-9-_]+

deviceUidsstring[]Required

storeUidstringRequiredPattern: ^[A-Za-z0-9-_]*

namestringRequired

descriptionstringRequired

typestring · enumRequiredPossible values:

pathstringRequired

createdBystringRequired

createdAtstring · date-timeRequired

lastModifiedBystringRequired

lastModifiedAtstring · date-timeRequired

post/tenants/{tenantUid}/printers

POST /v2/tenants/{tenantUid}/printers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "printerUid": "text",
  "type": "LABEL",
  "path": "text",
  "storeUid": "text",
  "name": "text",
  "description": "text",
  "settings": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "availablePrintActions": [
    "RECEIPT"
  ]
}

201

Example response

{
  "printerUid": "text",
  "deviceUids": [
    "text"
  ],
  "storeUid": "text",
  "name": "text",
  "description": "text",
  "type": "LABEL",
  "path": "text",
  "settings": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "availablePrintActions": [
    "RECEIPT"
  ],
  "createdBy": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z"
}