> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/printer/create-printer.md).

# Create printer

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

A `cloudprnt://` printer fetches its jobs from Flow (Star CloudPRNT). Its path becomes `cloudprnt://<printerUid>`. Send `cloudprntPassword` to choose its password, or leave it out and use the generated one returned once in `cloudprntCredentials`.

Required permissions: PRINTER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Printer","description":"Printer"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"PrinterResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrinterResponseSchema"}}},"headers":{}}},"schemas":{"PrinterResponseSchema":{"title":"PrinterResponseSchema","allOf":[{"type":"object","required":["printerUid","deviceUids","storeUid","name","description","type","path","settings","availablePrintActions"],"properties":{"printerUid":{"$ref":"#/components/schemas/UID"},"deviceUids":{"type":"array","items":{"$ref":"#/components/schemas/UID"}},"storeUid":{"$ref":"#/components/schemas/OptionalUID"},"name":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/PrinterTypeENUM"},"path":{"type":"string"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/GeneralParameterResponseSchema"}},"availablePrintActions":{"type":"array","description":"Which print job types this printer can handle. See [`AvailablePrintActionENUM`](#/components/schemas/AvailablePrintActionENUM).","items":{"$ref":"#/components/schemas/AvailablePrintActionENUM"}},"cloudLastPollAt":{"type":"string","format":"date-time","description":"When a CloudPRNT printer last polled. Empty for other printers."},"cloudStatusCode":{"type":"string","description":"The status a CloudPRNT printer last reported, e.g. \"200 OK\" or \"410 Paper Empty\"."},"cloudprntCredentials":{"$ref":"#/components/schemas/CloudPRNTCredentialsResponseSchema","description":"Only in the response to creating a CloudPRNT printer, or switching a printer to CloudPRNT, without `cloudprntPassword`. The generated password is shown here once and cannot be fetched again."}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"PrinterTypeENUM":{"title":"PrinterTypeENUM","type":"string","enum":["LABEL","RECEIPT","GENERAL"]},"GeneralParameterResponseSchema":{"title":"GeneralParameterResponseSchema","type":"object","required":["key","value","type","allowedValues","validationRegex","name","required"],"properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"$ref":"#/components/schemas/GeneralParameterTypeENUM"},"allowedValues":{"type":"array","items":{"type":"string"}},"validationRegex":{"type":"string"},"name":{"type":"string"},"required":{"type":"boolean"}}},"GeneralParameterTypeENUM":{"title":"GeneralSettingTypeENUM","type":"string","enum":["STRING","PASSWORD","INTEGER","DECIMAL","BOOL","ENUM"],"description":"| Type | Description |\n|--|--|\n|BOOL | Booleans will be the string `true` or `false` |\n|DECIMAL | Descimal numbers can only have two decimals and is represented as an integer multiplied by 100. Example: 1.2 is will be 120 and 5 will be 500 |\n|ENUM| The enum value should be one of the values listed in `allowedValues` |\n|PASSWORD | Treated the same way as STRING, but indicates to clients that this field should be hidden or masked. Used for tokens and passwords |"},"AvailablePrintActionENUM":{"description":"Supported print **capabilities** for a printer. Some values intentionally differ from the strings in\n[`PrinterTypeENUM`](#/components/schemas/PrinterTypeENUM) (hardware class: LABEL / RECEIPT) and\n[`OrderPrintTypeENUM`](#/components/schemas/OrderPrintTypeENUM) (order print request `type`), so clients\ndo not confuse `printer.type` with entries in `availablePrintActions`. Use the table below to map a\ncapability to the request `type` it enables.\n\n| ENUM | Meaning | Maps to |\n| ---- | ------- | ------- |\n| RECEIPT | Sales receipt print | `OrderPrintTypeENUM` RECEIPT |\n| EXCHANGENOTE | Exchange note print | `OrderPrintTypeENUM` EXCHANGENOTE |\n| GIFTCARD_BARCODE | Gift card barcode print | `OrderPrintTypeENUM` GIFTCARD |\n| PICKUP_LABEL | Pickup label / note print | `OrderPrintTypeENUM` PICKUP |\n| SHORTAGENOTE | Missing items note (restlapp) print | `OrderPrintTypeENUM` SHORTAGENOTE |\n| PICKNOTE | Pick note (plukkelapp) print | `OrderPrintTypeENUM` PICKNOTE |\n| PRODUCT | Product label print | Print-products API |\n| CUSTOMER_MEMBERSHIP_CARD | Customer membership card print | — |\n| SERVICE_INTAKE_SLIP | Service order intake slip print; every RECEIPT printer lists it | `ServiceOrderPrintTypeENUM` INTAKE_SLIP |\n","minLength":1,"title":"AvailablePrintActionENUM","type":"string","enum":["RECEIPT","EXCHANGENOTE","GIFTCARD_BARCODE","PICKUP_LABEL","SHORTAGENOTE","PICKNOTE","PRODUCT","CUSTOMER_MEMBERSHIP_CARD","SERVICE_INTAKE_SLIP"]},"CloudPRNTCredentialsResponseSchema":{"title":"CloudPRNTCredentialsResponseSchema","type":"object","required":["serverUrl","username","password"],"properties":{"serverUrl":{"type":"string","description":"The URL to enter as the CloudPRNT server on the printer."},"username":{"type":"string"},"password":{"type":"string","description":"Shown only in this response. Requesting new credentials replaces it."}}},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"PrinterUpdateRequestSchema":{"title":"PrinterUpdateRequestSchema","type":"object","properties":{"storeUid":{"$ref":"#/components/schemas/OptionalNullableUID"},"type":{"$ref":"#/components/schemas/PrinterTypeENUM"},"path":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/GeneralParameterRequestSchema"}},"availablePrintActions":{"type":"array","description":"Optional on update. Which print job types this printer can handle; effective values are reflected on printer responses (see [`AvailablePrintActionENUM`](#/components/schemas/AvailablePrintActionENUM)). When sent, an empty array means no categorized print types are configured for this printer (if the backend allows that).","items":{"$ref":"#/components/schemas/AvailablePrintActionENUM"}},"cloudprntPassword":{"type":"string","minLength":12,"maxLength":63,"description":"Only for a CloudPRNT printer (path `cloudprnt://`). The password the printer logs in with; enter the same one on the printer. 12 to 63 characters.\nLeft out on create, Flow generates one and returns it once in `cloudprntCredentials`. Left out on update, the password is unchanged for a printer that already is CloudPRNT; a printer switched to CloudPRNT gets a generated one, as on create."}}},"OptionalNullableUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*","nullable":true},"GeneralParameterRequestSchema":{"description":"GeneralParameterRequestSchema","title":"GeneralParameterRequestSchema","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]}},"requestBodies":{"PrinterCreateRequest":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["type","path"],"properties":{"printerUid":{"$ref":"#/components/schemas/OptionalUID"},"type":{"$ref":"#/components/schemas/PrinterTypeENUM"},"path":{"type":"string"}}},{"$ref":"#/components/schemas/PrinterUpdateRequestSchema"}]}}}}}},"paths":{"/tenants/{tenantUid}/printers":{"post":{"summary":"Create printer","responses":{"201":{"$ref":"#/components/responses/PrinterResponse"}},"operationId":"post-printers","description":"Supported protocols in the printer path are `lpd`,`jd`, `flowbox` and `cloudprnt`.\nE.g. `lpd://192.168.1.4/queuename` or `jd://192.168.11.2:9100/` or `flowbox://flowboxUid/flowboxPeripheralUid` or `cloudprnt://`.\n\nA `cloudprnt://` printer fetches its jobs from Flow (Star CloudPRNT). Its path becomes `cloudprnt://<printerUid>`. Send `cloudprntPassword` to choose its password, or leave it out and use the generated one returned once in `cloudprntCredentials`.\n\nRequired permissions: PRINTER","tags":["Printer"],"requestBody":{"$ref":"#/components/requestBodies/PrinterCreateRequest"}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/printer/create-printer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.