Printer

PreviousPrices NextProduct

Was this helpful?

Get printer

get

Get printer details

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

printerUidstringrequired

Reference to a printer

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

Responses

application/json

all ofoptional

get

GET /v2/tenants/{tenantUid}/printers/{printerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

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
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:14:44.113Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:14:44.113Z"
}

Delete printer

delete

Delete printer

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

printerUidstringrequired

Reference to a printer

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/printers/{printerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

Test printer

post

Test printer

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

printerUidstringrequired

Reference to a printer

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

Responses

post

POST /v2/tenants/{tenantUid}/printers/{printerUid}/test HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No Content

List printers

get

List printers, optionally for a store (query parameter).

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

storeUidstringoptional

Reference to a store

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/printers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "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
        }
      ],
      "createdBy": "text",
      "createdAt": "2025-04-18T01:14:44.113Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:14:44.113Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create printer

post

The printer path must be either a flowboxPeripheralUid or a print path. Supported protocols: lpd and jd. E.g. lpd://192.168.1.4/queuename or jd://192.168.11.2:9100/ or flowbox://flowboxPeripheralUid.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

all ofoptional

Responses

application/json

all ofoptional

post

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

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

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
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:14:44.113Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:14:44.113Z"
}

Search printers

post

Search printers

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Body

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

printerTypestring · enumoptionalAvailable options:

querystringoptional

Partial or full printer name search

Responses

application/json

objectoptional

post

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

{
  "storeUid": "text",
  "printerType": "LABEL",
  "query": "text"
}

200

Example response

{
  "items": [
    {
      "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
        }
      ],
      "createdBy": "text",
      "createdAt": "2025-04-18T01:14:44.113Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:14:44.113Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Update printer

put

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

printerUidstringrequired

Reference to a printer

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

Body

storeUidstring | nullableoptionalPattern: ^[A-Za-z0-9-_]*

typestring · enumoptionalAvailable options:

pathstringoptional

namestringoptional

descriptionstringoptional

settingsobject[]optional

GeneralParameterRequestSchema

Responses

application/json

all ofoptional

put

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

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

200

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
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:14:44.113Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:14:44.113Z"
}